# ffrich
**Not smart. Not comprehensive. Not guaranteed to work.**
`ffrich` 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.
## Usage
### On the command line
`ffrich` is is not self-aware. Any argument given to the `ffrich`
command is transparently given to the `ffmpeg` binary on
your system, without any form of validation.
```sh
ffrich <any_ffmpeg_command>
```
### Using as a library
`ffrich` can be used as a library: use the `ffrich.main`
function:
```python
ffrich.main(argv=None, stream=sys.stderr, encoding=None, console=rich.console.Console):
```
**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.
**console**: The rich console object to output to.
## Installation
Install from PyPI:
```sh
pip install ffrich
```
Install from Git:
```sh
pip install git+https://github.com/banksio/ffrich.git
```
Raw data
{
"_id": null,
"home_page": "https://github.com/banksio/ffrich",
"name": "ffrich",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ffmpeg, ffmpeg-command, progress-bar, python-script, cli",
"author": "banksio",
"author_email": "nathantb3@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d4/d3/a2af1c9bf096807dada1946e8bee32234f83f63ff629f595fd9a8a90297a/ffrich-0.2.1.tar.gz",
"platform": "any",
"description": "# ffrich\n\n**Not smart. Not comprehensive. Not guaranteed to work.**\n\n\n`ffrich` is an FFmpeg progress formatter. It will attempt to display a\nnice progress bar in the output, based on the raw `ffmpeg` output, as\nwell as an adaptative ETA timer.\n\n\n## Usage\n\n### On the command line\n\n`ffrich` is is not self-aware. Any argument given to the `ffrich`\ncommand is transparently given to the `ffmpeg` binary on\nyour system, without any form of validation.\n\n```sh\nffrich <any_ffmpeg_command>\n```\n\n### Using as a library\n\n`ffrich` can be used as a library: use the `ffrich.main`\nfunction:\n\n```python\nffrich.main(argv=None, stream=sys.stderr, encoding=None, console=rich.console.Console):\n```\n\n**argv**: The arguments to pass to `ffmpeg`, as an argument list.\n\n**stream**: The stream to which to write the progress bar and the output\n messages.\n\n**encoding**: The encoding of the terminal, used to decode the `ffmpeg` output.\n Defaults to `locale.getpreferredencoding()`, or *UTF-8* is locales\n are not available.\n\n**console**: The rich console object to output to.\n\n## Installation\n\nInstall from PyPI:\n\n```sh\npip install ffrich\n```\n\nInstall from Git:\n\n```sh\npip install git+https://github.com/banksio/ffrich.git\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple progress bar for ffmpeg, written in Python using rich",
"version": "0.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/banksio/ffrich/issues",
"Changelog": "https://github.com/banksio/ffrich/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/banksio/ffrich"
},
"split_keywords": [
"ffmpeg",
" ffmpeg-command",
" progress-bar",
" python-script",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b879b512773b13b466671082d377bb87aa809d2579731deef57db85050a51b3f",
"md5": "75a5c05fef6e6b6d7f31dd7dbe3f09f4",
"sha256": "ab8ebeae2251fec5eadcc23e5bb38fdca1bcee767a7728e016350459875f9dff"
},
"downloads": -1,
"filename": "ffrich-0.2.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "75a5c05fef6e6b6d7f31dd7dbe3f09f4",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 5941,
"upload_time": "2024-10-27T23:32:54",
"upload_time_iso_8601": "2024-10-27T23:32:54.658286Z",
"url": "https://files.pythonhosted.org/packages/b8/79/b512773b13b466671082d377bb87aa809d2579731deef57db85050a51b3f/ffrich-0.2.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d4d3a2af1c9bf096807dada1946e8bee32234f83f63ff629f595fd9a8a90297a",
"md5": "a03f2b8dbdb97510b4ba44864a10fe1c",
"sha256": "b2cce9d9d31232a069d78b779035998f1b10983b23d6ba3ef03320acd1da8f95"
},
"downloads": -1,
"filename": "ffrich-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "a03f2b8dbdb97510b4ba44864a10fe1c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5296,
"upload_time": "2024-10-27T23:32:56",
"upload_time_iso_8601": "2024-10-27T23:32:56.319454Z",
"url": "https://files.pythonhosted.org/packages/d4/d3/a2af1c9bf096807dada1946e8bee32234f83f63ff629f595fd9a8a90297a/ffrich-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 23:32:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "banksio",
"github_project": "ffrich",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ffrich"
}
JSON
