|
3 | 3 |
|
4 | 4 | |pypi| |pypi-status| |pypi-pyvers| |github-license| |github-status|
|
5 | 5 |
|
6 |
| -.. |pypi| image:: https://img.shields.io/pypi/v/ffmpegio |
| 6 | +.. |pypi| image:: https://img.shields.io/pypi/v/ffmpegio-plugin-downloader |
7 | 7 | :alt: PyPI
|
8 |
| -.. |pypi-status| image:: https://img.shields.io/pypi/status/ffmpegio |
| 8 | +.. |pypi-status| image:: https://img.shields.io/pypi/status/ffmpegio-plugin-downloader |
9 | 9 | :alt: PyPI - Status
|
10 |
| -.. |pypi-pyvers| image:: https://img.shields.io/pypi/pyversions/ffmpegio |
| 10 | +.. |pypi-pyvers| image:: https://img.shields.io/pypi/pyversions/ffmpegio-plugin-downloader |
11 | 11 | :alt: PyPI - Python Version
|
12 |
| -.. |github-license| image:: https://img.shields.io/github/license/python-ffmpegio/python-ffmpegio |
| 12 | +.. |github-license| image:: https://img.shields.io/github/license/python-ffmpegio/python-ffmpegio-plugin-downloader |
13 | 13 | :alt: GitHub License
|
14 |
| -.. |github-status| image:: https://img.shields.io/github/workflow/status/python-ffmpegio/python-ffmpegio/Run%20Tests |
| 14 | +.. |github-status| image:: https://img.shields.io/github/workflow/status/python-ffmpegio/python-ffmpegio-plugin-downloader/Run%20Tests |
15 | 15 | :alt: GitHub Workflow Status
|
16 | 16 |
|
17 |
| -Python `ffmpegio` package aims to bring the full capability of `FFmpeg <https://ffmpeg.org>`__ |
18 |
| -to read, write, and manipulate multimedia data to Python. FFmpeg is an open-source cross-platform |
19 |
| -multimedia framework, which can handle most of the multimedia formats available today. |
| 17 | +`Python ffmpegio <https://python-ffmpegio.github.io/python-ffmpegio/>`__ package aims to bring |
| 18 | +the full capability of `FFmpeg <https://ffmpeg.org>`__ to read, write, and manipulate multimedia |
| 19 | +data to Python. FFmpeg is an open-source cross-platform multimedia framework, which can handle |
| 20 | +most of the multimedia formats available today. |
20 | 21 |
|
21 |
| -`ffmpegio-plugin-downloader` adds a capability to download the latest release build of |
22 |
| -FFmpeg via officially acknowledged host servers. |
| 22 | +One caveat of FFmpeg is that there is no formal program installer for Windows and MacOS (although |
| 23 | +`homebrew` could be used for the latter). `ffmpegio-plugin-downloader` adds a capability to download |
| 24 | +the latest release build of FFmpeg and use it in `ffmpegio` without any user intervention. This |
| 25 | +mechanism is supported by `ffmpeg-downloader <https://github.com/python-ffmpegio/python-ffmpeg-downloader>__` |
| 26 | +package. Downloading of the release build must be performed manually from the terminal screen, |
| 27 | +outside of Python. |
23 | 28 |
|
24 |
| -.. code-block:: bash |
| 29 | +Use |
| 30 | +=== |
| 31 | + |
| 32 | +Install the package (which also installs `ffmpeg-downloader` package). Then, run `ffmpeg_downloader` to |
| 33 | +download and install the latest release: |
25 | 34 |
|
26 |
| - pip install ffmpegio-core # or ffmpegio if using it with its NumPy interface |
| 35 | +.. code-block:: bash |
27 | 36 |
|
28 | 37 | pip install ffmpegio_plugin_downloader
|
29 | 38 |
|
30 | 39 | python -m ffmpeg_downloader # downloads and installs the latest release
|
31 | 40 |
|
32 |
| -Documentation |
33 |
| -------------- |
| 41 | +Once the plugin and the FFmpeg executables are installed, `ffmpegio` will automatically |
| 42 | +detects the downloaded executables. (Exception: `ffmpegio` searches the system PATH first. |
| 43 | +So, if `ffmpeg` and `ffprobe` are already available on the system, `ffmpegio_plugin_downloader` |
| 44 | +will never be called.) |
| 45 | + |
| 46 | +At a later date, the installed FFmpeg can be updated to the latest release |
| 47 | + |
| 48 | +.. code-block:: bash |
| 49 | +
|
| 50 | + python -m ffmpeg_downloader -U # downloads and updates to the latest release |
34 | 51 |
|
35 |
| -Visit our `GitHub page here <https://python-ffmpegio.github.io/python-ffmpegio/>`__ |
|
0 commit comments