pffmpeg


Namepffmpeg JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryProgress bar for FFmpeg
upload_time2024-07-22 21:58:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2024 Clément GUICHARD Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords ffmpeg progress rich
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PFFmpeg

<div align="center" style="margin:40px;">
  <img src="https://raw.githubusercontent.com/CGuichard/pffmpeg/main/docs/src/assets/img/logo.png" alt="PFFmpeg logo" style="margin-bottom: 20px" width="300"/>

  _Progress bar for FFmpeg_

  <!-- --8<-- [start:overview-header] -->
  [![Language](https://img.shields.io/badge/Language-python≥3.10-3776ab?style=flat-square&logo=Python)](https://www.python.org/)
  ![License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
  [![Documentation](https://img.shields.io/badge/Documentation-mkdocs-0a507a?style=flat-square)](https://cguichard.github.io/pffmpeg/)
  ![Style](https://img.shields.io/badge/Style-ruff-9a9a9a?style=flat-square)
  ![Lint](https://img.shields.io/badge/Lint-ruff,%20mypy-brightgreen?style=flat-square)
  ![Security](https://img.shields.io/badge/Security-bandit,%20pip%20audit-purple?style=flat-square)
  [![Tests](https://github.com/CGuichard/pffmpeg/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/CGuichard/pffmpeg/actions/workflows/tests.yml)

  [Pull Request](https://github.com/CGuichard/pffmpeg/pulls) **·**
  [Bug Report](https://github.com/CGuichard/pffmpeg/issues/new?template=bug_report.md) **·**
  [Feature Request](https://github.com/CGuichard/pffmpeg/issues/new?template=feature_request.md)
  <!-- --8<-- [end:overview-header] -->

</div>

<!-- --8<-- [start:overview-body] -->
---

**Documentation**: <a href="https://cguichard.github.io/pffmpeg" target="_blank">https://cguichard.github.io/pffmpeg</a>

**Source Code**: <a href="https://github.com/CGuichard/pffmpeg" target="_blank">https://github.com/CGuichard/pffmpeg</a>

---

The FFmpeg command line tool is a universal media converter. It can read a wide variety of inputs,
filter and transcode them into a plethora of output formats. For new user it can be extremely
convoluted to use, and read the output. When converting a video file for the first time,
understanding the progress of the current task from the output is quite the confusing task.

This is where PFFmpeg comes in. It's CLI is just on top of FFmpeg's, and delegates everything to it.
The output of the FFmpeg is parsed and "patched" to display a progress bar while running an action
such as a video compression. PFFmpeg philosophy is to alter as little as possible the FFmpeg experience,
and simply add the progress bar when needed, unlike other project who just wrap and hide all of the
output behind a progress bar. In terms of style, the
[`rich`](https://rich.readthedocs.io/en/latest/progress.html) progress bar was chosen.

<!-- --8<-- [end:overview-body] -->
## Table of Contents

- [Quick start](#quick-start)
- [Contributing](#contributing)
- [License](#license)

## Quick start

Install PFFmpeg with pip (from PyPI):

```bash
pip install pffmpeg
```

You can use any `ffmpeg` command with `pffmpeg`:

```bash
# Print help
pffmpeg -h

# Print version
pffmpeg -version

# Video processing
pffmpeg -i input.mp4 output.mp4
```

Demo:

![Demo pffmpeg](./docs/src/assets/img/demo-pffmpeg.gif)

## Contributing

If you want to contribute to this project or understand how it works,
please check [CONTRIBUTING.md](CONTRIBUTING.md).

Any contribution is greatly appreciated.

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for more
information.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pffmpeg",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "ffmpeg, progress, rich",
    "author": null,
    "author_email": "Cl\u00e9ment GUICHARD <clement.guichard0@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/31/91/67aa60e330b1e8f61699507c780d505907021333b1fcbff5ae5e111717cf/pffmpeg-1.0.0.tar.gz",
    "platform": null,
    "description": "# PFFmpeg\n\n<div align=\"center\" style=\"margin:40px;\">\n  <img src=\"https://raw.githubusercontent.com/CGuichard/pffmpeg/main/docs/src/assets/img/logo.png\" alt=\"PFFmpeg logo\" style=\"margin-bottom: 20px\" width=\"300\"/>\n\n  _Progress bar for FFmpeg_\n\n  <!-- --8<-- [start:overview-header] -->\n  [![Language](https://img.shields.io/badge/Language-python\u22653.10-3776ab?style=flat-square&logo=Python)](https://www.python.org/)\n  ![License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)\n  [![Documentation](https://img.shields.io/badge/Documentation-mkdocs-0a507a?style=flat-square)](https://cguichard.github.io/pffmpeg/)\n  ![Style](https://img.shields.io/badge/Style-ruff-9a9a9a?style=flat-square)\n  ![Lint](https://img.shields.io/badge/Lint-ruff,%20mypy-brightgreen?style=flat-square)\n  ![Security](https://img.shields.io/badge/Security-bandit,%20pip%20audit-purple?style=flat-square)\n  [![Tests](https://github.com/CGuichard/pffmpeg/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/CGuichard/pffmpeg/actions/workflows/tests.yml)\n\n  [Pull Request](https://github.com/CGuichard/pffmpeg/pulls) **\u00b7**\n  [Bug Report](https://github.com/CGuichard/pffmpeg/issues/new?template=bug_report.md) **\u00b7**\n  [Feature Request](https://github.com/CGuichard/pffmpeg/issues/new?template=feature_request.md)\n  <!-- --8<-- [end:overview-header] -->\n\n</div>\n\n<!-- --8<-- [start:overview-body] -->\n---\n\n**Documentation**: <a href=\"https://cguichard.github.io/pffmpeg\" target=\"_blank\">https://cguichard.github.io/pffmpeg</a>\n\n**Source Code**: <a href=\"https://github.com/CGuichard/pffmpeg\" target=\"_blank\">https://github.com/CGuichard/pffmpeg</a>\n\n---\n\nThe FFmpeg command line tool is a universal media converter. It can read a wide variety of inputs,\nfilter and transcode them into a plethora of output formats. For new user it can be extremely\nconvoluted to use, and read the output. When converting a video file for the first time,\nunderstanding the progress of the current task from the output is quite the confusing task.\n\nThis is where PFFmpeg comes in. It's CLI is just on top of FFmpeg's, and delegates everything to it.\nThe output of the FFmpeg is parsed and \"patched\" to display a progress bar while running an action\nsuch as a video compression. PFFmpeg philosophy is to alter as little as possible the FFmpeg experience,\nand simply add the progress bar when needed, unlike other project who just wrap and hide all of the\noutput behind a progress bar. In terms of style, the\n[`rich`](https://rich.readthedocs.io/en/latest/progress.html) progress bar was chosen.\n\n<!-- --8<-- [end:overview-body] -->\n## Table of Contents\n\n- [Quick start](#quick-start)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Quick start\n\nInstall PFFmpeg with pip (from PyPI):\n\n```bash\npip install pffmpeg\n```\n\nYou can use any `ffmpeg` command with `pffmpeg`:\n\n```bash\n# Print help\npffmpeg -h\n\n# Print version\npffmpeg -version\n\n# Video processing\npffmpeg -i input.mp4 output.mp4\n```\n\nDemo:\n\n![Demo pffmpeg](./docs/src/assets/img/demo-pffmpeg.gif)\n\n## Contributing\n\nIf you want to contribute to this project or understand how it works,\nplease check [CONTRIBUTING.md](CONTRIBUTING.md).\n\nAny contribution is greatly appreciated.\n\n## License\n\nDistributed under the MIT License. See [LICENSE](LICENSE) for more\ninformation.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Cl\u00e9ment GUICHARD  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Progress bar for FFmpeg",
    "version": "1.0.0",
    "project_urls": {
        "Changelog": "https://cguichard.github.io/pffmpeg/changelog/",
        "Documentation": "https://cguichard.github.io/pffmpeg/",
        "Homepage": "https://pypi.org/project/pffmpeg/",
        "Source": "https://github.com/CGuichard/pffmpeg",
        "Tracker": "https://github.com/CGuichard/pffmpeg/issues"
    },
    "split_keywords": [
        "ffmpeg",
        " progress",
        " rich"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b0dba96b16d47dfeed6cae353435abd759c9ca9d1e5be7b650a0f6d97560e2db",
                "md5": "b665bd0c28fa8444a4e9a4f03ece79a0",
                "sha256": "028dd10525850fb096e08e0f26c4cc3f375149e08ef262f2e028c3fec78e3fce"
            },
            "downloads": -1,
            "filename": "pffmpeg-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b665bd0c28fa8444a4e9a4f03ece79a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10328,
            "upload_time": "2024-07-22T21:58:19",
            "upload_time_iso_8601": "2024-07-22T21:58:19.196285Z",
            "url": "https://files.pythonhosted.org/packages/b0/db/a96b16d47dfeed6cae353435abd759c9ca9d1e5be7b650a0f6d97560e2db/pffmpeg-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "319167aa60e330b1e8f61699507c780d505907021333b1fcbff5ae5e111717cf",
                "md5": "5826919304d9055f5af8ef8373b8f111",
                "sha256": "4d53e1885d2713a5f0ec69fedddd9de3bd7fb3f14bac025e28acdf431cfb7a62"
            },
            "downloads": -1,
            "filename": "pffmpeg-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5826919304d9055f5af8ef8373b8f111",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 1231946,
            "upload_time": "2024-07-22T21:58:20",
            "upload_time_iso_8601": "2024-07-22T21:58:20.558043Z",
            "url": "https://files.pythonhosted.org/packages/31/91/67aa60e330b1e8f61699507c780d505907021333b1fcbff5ae5e111717cf/pffmpeg-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-22 21:58:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CGuichard",
    "github_project": "pffmpeg",
    "github_not_found": true,
    "lcname": "pffmpeg"
}
        
Elapsed time: 0.28454s