Installation
Medix is distributed on PyPI and mirrored on libraries.io. Pick the method that matches your workflow.
From PyPI (recommended)
Section titled “From PyPI (recommended)”The simplest path. Works on any platform with Python 3.9+.
pip install medixUpgrade later with:
pip install -U medixWith pipx (isolated global install)
Section titled “With pipx (isolated global install)”pipx installs CLI tools into isolated environments so they don’t pollute your system Python. Strongly recommended if you use Medix as a day-to-day tool.
pipx install medixUpgrade:
pipx upgrade medixUninstall:
pipx uninstall medixFrom source
Section titled “From source”Clone the repo and install in editable mode. Useful if you’re following
main or want to contribute.
git clone https://github.com/vineethkrishnan/medix.gitcd medix
python3 -m venv .venvsource .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e .Development install
Section titled “Development install”Same as source, but includes test and lint tooling.
pip install -e ".[dev]"This pulls in pytest, pytest-cov, and ruff.
From a Git tag / branch directly
Section titled “From a Git tag / branch directly”pip install "git+https://github.com/vineethkrishnan/medix.git@main"Replace @main with any tag (e.g. @v1.3.0) or branch.
As a dependency in pyproject.toml
Section titled “As a dependency in pyproject.toml”[project]dependencies = [ "medix>=1.3.0",]Verify the install
Section titled “Verify the install”medix --versionYou should see the installed version printed. You can also invoke Medix as a module:
python -m medix --versionFFmpeg
Section titled “FFmpeg”Medix needs FFmpeg and ffprobe at runtime, but you don’t have to install
them first. On first run, Medix detects your platform and offers to install
them automatically. If you’d rather do it yourself:
# macOSbrew install ffmpeg
# Ubuntu / Debiansudo apt install ffmpeg
# Fedorasudo dnf install ffmpeg
# Archsudo pacman -S ffmpeg
# Windows (winget)winget install Gyan.FFmpegSee FFmpeg Auto-Install for the full list.
Next steps
Section titled “Next steps”- Quick Start — convert your first file
- CLI Usage — all the flags
- Dry Run — preview before converting