vid-cleaner

Tools to transcode, inspect and convert videos.


License
AGPL-3.0
Install
pip install vid-cleaner==0.3.2

Documentation

PyPI version PyPI - Python Version Python Code Checker codecov

Vid Cleaner

Tools to transcode, inspect and convert videos. This package provides convenience wrappers around ffmpeg and ffprobe 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:

To install vid-cleaner, run:

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
  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 standard to automate Semantic Versioning and Keep A Changelog with 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 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.