``ffpb`` |stars|
================
.. |stars| image:: https://img.shields.io/github/stars/althonos/ffpb.svg?style=social&maxAge=3600&label=Star
:target: https://github.com/althonos/ffpb/stargazers
**Not smart. Not comprehensive. Not guaranteed to work.**
|Source| |PyPI| |AppVeyor| |Format| |License| |Changelog| |Downloads|
.. |PyPI| image:: https://img.shields.io/pypi/v/ffpb.svg?style=flat-square&maxAge=300
:target: https://pypi.python.org/pypi/ffpb
.. |AppVeyor| image:: https://img.shields.io/appveyor/build/althonos/ffpb.svg?style=flat-square&maxAge=3600
:target: https://ci.appveyor.com/project/althonos/ffpb
.. |Format| image:: https://img.shields.io/pypi/format/ffpb.svg?style=flat-square&maxAge=300
:target: https://pypi.python.org/pypi/ffpb
.. |Versions| image:: https://img.shields.io/pypi/pyversions/ffpb.svg?style=flat-square&maxAge=300
:target: https://travis-ci.org/althonos/ffpb/
.. |License| image:: https://img.shields.io/pypi/l/ffpb.svg?style=flat-square&maxAge=300
:target: https://choosealicense.com/licenses/mit/
.. |Source| image:: https://img.shields.io/badge/source-GitHub-303030.svg?maxAge=3600&style=flat-square
:target: https://github.com/althonos/ffpb/
.. |Changelog| image:: https://img.shields.io/badge/keep%20a-changelog-8A0707.svg?maxAge=2678400&style=flat-square
:target: http://keepachangelog.com/
.. |Downloads| image:: https://img.shields.io/badge/dynamic/json?style=flat-square&color=303f9f&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fffpb
:target: https://pepy.tech/project/ffpb
``ffpb`` is an FFmpeg progress formatter. It will attempt to display a nice
progress bar in the output, based on the raw ``ffmpeg`` output, as well as an
adaptative ETA timer.
Showcase
--------
.. image:: https://github.com/althonos/ffpb/raw/master/static/showcase.v1.gif
(*yes, my laptop can't encode shit*)
Usage
-----
``ffpb`` is is not even self-aware. Any argument given to the ``ffpb`` command
is transparently given to the `ffmpeg` binary on your system, without any form
of validation. So if you know how to use the FFmpeg CLI, you know how to use
``ffpb`` !
Using as a library
^^^^^^^^^^^^^^^^^^
`ffpb` can be used as a library: use the ``ffpb.main`` function:
.. code:: python
ffpb.main(argv=None, stream=sys.stderr, encoding=None, tqdm=tqdm):
argv
The arguments to pass to ``ffmpeg``, as an argument list.
stream
The stream to which to write the progress bar and the output messages.
encoding
The encoding of the terminal, used to decode the ``ffmpeg`` output.
Defaults to ``locale.getpreferredencoding()``, or *UTF-8* is locales are
not available.
tqdm
The progress bar factory to use. A subclass of
`tqdm.tqdm <https://tqdm.github.io/docs/tqdm/#tqdm-objects>`_ is expected.
Check `althonos/ffpb#19 <https://github.com/althonos/ffpb/issues/19>`_ to
see how you can use this to wrap ``ffpb`` in your own UI.
Installation
------------
Install from PyPI:
.. code:: console
$ pip install --user ffpb
Alternatively, download a development version from the GitHub ``master`` branch:
.. code:: console
$ pip install https://github.com/althonos/ffpb/archive/master.zip
Or if you use an Arch-based distro, `download from the AUR`__
.. __: https://aur.archlinux.org/packages/ffpb/
Raw data
{
"_id": null,
"home_page": "https://github.com/althonos/ffpb",
"name": "ffpb",
"maintainer": "",
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7",
"maintainer_email": "",
"keywords": "ffmpeg,ffmpeg-command,progress-bar,python-script,cli",
"author": "Martin Larralde",
"author_email": "martin.larralde@ens-paris-saclay.fr",
"download_url": "https://files.pythonhosted.org/packages/e1/81/65fd092de53b2769cc301ea8b787ee7b83a39c416820c02a199464ba7177/ffpb-0.4.1.tar.gz",
"platform": "any",
"description": "``ffpb`` |stars|\n================\n\n.. |stars| image:: https://img.shields.io/github/stars/althonos/ffpb.svg?style=social&maxAge=3600&label=Star\n :target: https://github.com/althonos/ffpb/stargazers\n\n**Not smart. Not comprehensive. Not guaranteed to work.**\n\n|Source| |PyPI| |AppVeyor| |Format| |License| |Changelog| |Downloads|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/ffpb.svg?style=flat-square&maxAge=300\n :target: https://pypi.python.org/pypi/ffpb\n\n.. |AppVeyor| image:: https://img.shields.io/appveyor/build/althonos/ffpb.svg?style=flat-square&maxAge=3600\n :target: https://ci.appveyor.com/project/althonos/ffpb\n\n.. |Format| image:: https://img.shields.io/pypi/format/ffpb.svg?style=flat-square&maxAge=300\n :target: https://pypi.python.org/pypi/ffpb\n\n.. |Versions| image:: https://img.shields.io/pypi/pyversions/ffpb.svg?style=flat-square&maxAge=300\n :target: https://travis-ci.org/althonos/ffpb/\n\n.. |License| image:: https://img.shields.io/pypi/l/ffpb.svg?style=flat-square&maxAge=300\n :target: https://choosealicense.com/licenses/mit/\n\n.. |Source| image:: https://img.shields.io/badge/source-GitHub-303030.svg?maxAge=3600&style=flat-square\n :target: https://github.com/althonos/ffpb/\n\n.. |Changelog| image:: https://img.shields.io/badge/keep%20a-changelog-8A0707.svg?maxAge=2678400&style=flat-square\n :target: http://keepachangelog.com/\n\n.. |Downloads| image:: https://img.shields.io/badge/dynamic/json?style=flat-square&color=303f9f&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fffpb\n :target: https://pepy.tech/project/ffpb\n\n``ffpb`` is an FFmpeg progress formatter. It will attempt to display a nice\nprogress bar in the output, based on the raw ``ffmpeg`` output, as well as an\nadaptative ETA timer.\n\n\nShowcase\n--------\n\n.. image:: https://github.com/althonos/ffpb/raw/master/static/showcase.v1.gif\n\n(*yes, my laptop can't encode shit*)\n\n\nUsage\n-----\n\n``ffpb`` is is not even self-aware. Any argument given to the ``ffpb`` command\nis transparently given to the `ffmpeg` binary on your system, without any form\nof validation. So if you know how to use the FFmpeg CLI, you know how to use\n``ffpb`` !\n\nUsing as a library\n^^^^^^^^^^^^^^^^^^\n\n`ffpb` can be used as a library: use the ``ffpb.main`` function:\n\n.. code:: python\n\n ffpb.main(argv=None, stream=sys.stderr, encoding=None, tqdm=tqdm):\n\n\nargv\n The arguments to pass to ``ffmpeg``, as an argument list.\nstream\n The stream to which to write the progress bar and the output messages.\nencoding\n The encoding of the terminal, used to decode the ``ffmpeg`` output.\n Defaults to ``locale.getpreferredencoding()``, or *UTF-8* is locales are\n not available.\ntqdm\n The progress bar factory to use. A subclass of\n `tqdm.tqdm <https://tqdm.github.io/docs/tqdm/#tqdm-objects>`_ is expected.\n Check `althonos/ffpb#19 <https://github.com/althonos/ffpb/issues/19>`_ to\n see how you can use this to wrap ``ffpb`` in your own UI.\n\nInstallation\n------------\n\nInstall from PyPI:\n\n.. code:: console\n\n $ pip install --user ffpb\n\n\nAlternatively, download a development version from the GitHub ``master`` branch:\n\n.. code:: console\n\n $ pip install https://github.com/althonos/ffpb/archive/master.zip\n\nOr if you use an Arch-based distro, `download from the AUR`__\n\n.. __: https://aur.archlinux.org/packages/ffpb/\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A progress bar for ffmpeg. Yay !",
"version": "0.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/althonos/ffpb/issues",
"Changelog": "https://github.com/althonos/ffpb/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/althonos/ffpb"
},
"split_keywords": [
"ffmpeg",
"ffmpeg-command",
"progress-bar",
"python-script",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01c7ecf79fbab51a8a2a47af9b8ec01d7250a2876590c6a57c28e668dc296a4a",
"md5": "ad0ee9b310891d651015fb85cbbeb3f4",
"sha256": "0e3e2962f4812e39f29649f09785e7cd877ea7f0e14e84d17918c33618647321"
},
"downloads": -1,
"filename": "ffpb-0.4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ad0ee9b310891d651015fb85cbbeb3f4",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7",
"size": 6185,
"upload_time": "2021-02-13T13:06:48",
"upload_time_iso_8601": "2021-02-13T13:06:48.782552Z",
"url": "https://files.pythonhosted.org/packages/01/c7/ecf79fbab51a8a2a47af9b8ec01d7250a2876590c6a57c28e668dc296a4a/ffpb-0.4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e18165fd092de53b2769cc301ea8b787ee7b83a39c416820c02a199464ba7177",
"md5": "df2c9a31df96a2587af66ea987c875db",
"sha256": "ede56a6cba4c1d2d6c070daf612e1c4edc957679e49c6b4423cd7dd159577e59"
},
"downloads": -1,
"filename": "ffpb-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "df2c9a31df96a2587af66ea987c875db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7",
"size": 7098,
"upload_time": "2021-02-13T13:06:49",
"upload_time_iso_8601": "2021-02-13T13:06:49.933764Z",
"url": "https://files.pythonhosted.org/packages/e1/81/65fd092de53b2769cc301ea8b787ee7b83a39c416820c02a199464ba7177/ffpb-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-02-13 13:06:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "althonos",
"github_project": "ffpb",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"appveyor": true,
"lcname": "ffpb"
}
JSON
