Skip to content

Commit

Permalink
compile readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lucemia committed Apr 9, 2024
1 parent 869ee83 commit 99754d9
Show file tree
Hide file tree
Showing 7 changed files with 586 additions and 5 deletions.
383 changes: 383 additions & 0 deletions README.ipynb

Large diffs are not rendered by default.

32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ Note: This requires Graphviz to be installed on your system.

Here's how to quickly start using `typed-ffmpeg`:




```python
import ffmpeg

Expand All @@ -80,37 +83,56 @@ f = (
.hflip()
.output(filename='output.mp4')
)
f.run()
f
```

![](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/quick-usage.png)




![svg](README_files/README_1_0.svg)




For a more complex example:



```python
import ffmpeg.filters
import ffmpeg

# Complex filter graph example
in_file = ffmpeg.input("input.mp4")
overlay_file = ffmpeg.input("overlay.png")

f = (
ffmpeg
ffmpeg.filters
.concat(
in_file.trim(start_frame=10, end_frame=20),
in_file.trim(start_frame=30, end_frame=40),
)
.video(0)
.overlay(overlay_file.hflip())
.drawbox(x="50", y="50", width="120", height="120", color="red", thickness="5")
.output(filename="out.mp4")
)
f.run()
f
```

![](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/quick-usage-complex.png)




![svg](README_files/README_3_0.svg)




See the [Usage](https://livingbio.github.io/typed-ffmpeg/usage/typed/) section in our documentation for more examples and detailed guides.


---

## Acknowledgements
Expand Down
Binary file added README_files/README_1_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions README_files/README_1_0.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README_files/README_3_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
130 changes: 130 additions & 0 deletions README_files/README_3_0.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions scripts/compile-readme.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
jupyter nbconvert --to markdown README.ipynb

0 comments on commit 99754d9

Please sign in to comment.