[](https://badge.fury.io/py/vid-cleaner)  [](https://github.com/natelandau/vid-cleaner/actions/workflows/automated-tests.yml) [](https://codecov.io/gh/natelandau/vid-cleaner)
# Vid Cleaner
Tools to transcode, inspect and convert videos. This package provides convenience wrappers around [ffmpeg](https://ffmpeg.org/) and [ffprobe](https://ffmpeg.org/ffprobe.html) to make it easier to work with video files. The functionality is highly customized to my personal workflows and needs. I am sharing it in case it is useful to others.
## Features
- Remove commentary tracks and subtitles
- Remove unwanted audio and subtitle tracks
- Convert to H.265 or VP9
- Convert 4k to 1080p
- Downmix from surround to create missing stereo streams with custom filters to improve quality
- Removes unwanted audio and subtitle tracks, optionally keeping the original language audio track
- Create clips from a video file
## Install
Before installing vid-cleaner, the following dependencies must be installed:
- [ffmpeg](https://ffmpeg.org/)
- [ffprobe](https://ffmpeg.org/ffprobe.html)
- python 3.11+
To install vid-cleaner, run:
```bash
pip install vid-cleaner
```
## Usage
Run `vidcleaner --help` to see the available commands and options.
## Contributing
## Setup: Once per project
1. Install Python 3.11 and [Poetry](https://python-poetry.org)
2. Clone this repository. `git clone https://github.com/natelandau/vid-cleaner`
3. Install the Poetry environment with `poetry install`.
4. Activate your Poetry environment with `poetry shell`.
5. Install the pre-commit hooks with `pre-commit install --install-hooks`.
## Developing
- This project follows the [Conventional Commits](https://www.conventionalcommits.org/) standard to automate [Semantic Versioning](https://semver.org/) and [Keep A Changelog](https://keepachangelog.com/) with [Commitizen](https://github.com/commitizen-tools/commitizen).
- When you're ready to commit changes run `cz c`
- Run `poe` from within the development environment to print a list of [Poe the Poet](https://github.com/nat-n/poethepoet) tasks available to run on this project. Common commands:
- `poe lint` runs all linters
- `poe test` runs all tests with Pytest
- Run `poetry add {package}` from within the development environment to install a run time dependency and add it to `pyproject.toml` and `poetry.lock`.
- Run `poetry remove {package}` from within the development environment to uninstall a run time dependency and remove it from `pyproject.toml` and `poetry.lock`.
- Run `poetry update` from within the development environment to upgrade all dependencies to the latest versions allowed by `pyproject.toml`.
Raw data
{
"_id": null,
"home_page": "https://github.com/natelandau/vid-cleaner",
"name": "vid-cleaner",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Nate Landau",
"author_email": "github@natenate.org",
"download_url": "https://files.pythonhosted.org/packages/8a/9c/72fcbf9731b738f041999b7fe17464e7204415b8ec89f417b47de1791933/vid_cleaner-0.3.2.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/vid-cleaner)  [](https://github.com/natelandau/vid-cleaner/actions/workflows/automated-tests.yml) [](https://codecov.io/gh/natelandau/vid-cleaner)\n\n# Vid Cleaner\n\nTools to transcode, inspect and convert videos. This package provides convenience wrappers around [ffmpeg](https://ffmpeg.org/) and [ffprobe](https://ffmpeg.org/ffprobe.html) to make it easier to work with video files. The functionality is highly customized to my personal workflows and needs. I am sharing it in case it is useful to others.\n\n## Features\n\n- Remove commentary tracks and subtitles\n- Remove unwanted audio and subtitle tracks\n- Convert to H.265 or VP9\n- Convert 4k to 1080p\n- Downmix from surround to create missing stereo streams with custom filters to improve quality\n- Removes unwanted audio and subtitle tracks, optionally keeping the original language audio track\n- Create clips from a video file\n\n## Install\n\nBefore installing vid-cleaner, the following dependencies must be installed:\n\n- [ffmpeg](https://ffmpeg.org/)\n- [ffprobe](https://ffmpeg.org/ffprobe.html)\n- python 3.11+\n\nTo install vid-cleaner, run:\n\n```bash\npip install vid-cleaner\n```\n\n## Usage\n\nRun `vidcleaner --help` to see the available commands and options.\n\n## Contributing\n\n## Setup: Once per project\n\n1. Install Python 3.11 and [Poetry](https://python-poetry.org)\n2. Clone this repository. `git clone https://github.com/natelandau/vid-cleaner`\n3. Install the Poetry environment with `poetry install`.\n4. Activate your Poetry environment with `poetry shell`.\n5. Install the pre-commit hooks with `pre-commit install --install-hooks`.\n\n## Developing\n\n- This project follows the [Conventional Commits](https://www.conventionalcommits.org/) standard to automate [Semantic Versioning](https://semver.org/) and [Keep A Changelog](https://keepachangelog.com/) with [Commitizen](https://github.com/commitizen-tools/commitizen).\n - When you're ready to commit changes run `cz c`\n- Run `poe` from within the development environment to print a list of [Poe the Poet](https://github.com/nat-n/poethepoet) tasks available to run on this project. Common commands:\n - `poe lint` runs all linters\n - `poe test` runs all tests with Pytest\n- Run `poetry add {package}` from within the development environment to install a run time dependency and add it to `pyproject.toml` and `poetry.lock`.\n- Run `poetry remove {package}` from within the development environment to uninstall a run time dependency and remove it from `pyproject.toml` and `poetry.lock`.\n- Run `poetry update` from within the development environment to upgrade all dependencies to the latest versions allowed by `pyproject.toml`.\n",
"bugtrack_url": null,
"license": null,
"summary": "Tools to transcode, inspect and convert videos.",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/natelandau/vid-cleaner",
"Repository": "https://github.com/natelandau/vid-cleaner"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01a966c5df6955ebb083c5d92e1144185a77b86563465dac4c62f13a5f72d8c7",
"md5": "d6fa381167d9f2c4a2209b1c62c0d1b4",
"sha256": "2f7a5d795e3b454edea415252e1b2460293bf28bebaa84aaab544eff39879387"
},
"downloads": -1,
"filename": "vid_cleaner-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6fa381167d9f2c4a2209b1c62c0d1b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 38799,
"upload_time": "2024-04-28T17:42:50",
"upload_time_iso_8601": "2024-04-28T17:42:50.598761Z",
"url": "https://files.pythonhosted.org/packages/01/a9/66c5df6955ebb083c5d92e1144185a77b86563465dac4c62f13a5f72d8c7/vid_cleaner-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a9c72fcbf9731b738f041999b7fe17464e7204415b8ec89f417b47de1791933",
"md5": "424d7521be4e46bec7aa37f54cc66687",
"sha256": "1630b39c4c5a4e6fc8b1af0f568debe4564cfa0006cc644efebb7e20e8772518"
},
"downloads": -1,
"filename": "vid_cleaner-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "424d7521be4e46bec7aa37f54cc66687",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 36644,
"upload_time": "2024-04-28T17:42:52",
"upload_time_iso_8601": "2024-04-28T17:42:52.305860Z",
"url": "https://files.pythonhosted.org/packages/8a/9c/72fcbf9731b738f041999b7fe17464e7204415b8ec89f417b47de1791933/vid_cleaner-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 17:42:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "natelandau",
"github_project": "vid-cleaner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vid-cleaner"
}
JSON
