Skip to content
Medix

Installation

Medix is distributed on PyPI and mirrored on libraries.io. Pick the method that matches your workflow.

The simplest path. Works on any platform with Python 3.9+.

Terminal window
pip install medix

Upgrade later with:

Terminal window
pip install -U medix

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.

Terminal window
pipx install medix

Upgrade:

Terminal window
pipx upgrade medix

Uninstall:

Terminal window
pipx uninstall medix

From source

Clone the repo and install in editable mode. Useful if you’re following main or want to contribute.

Terminal window
git clone https://github.com/vineethkrishnan/medix.git
cd medix


python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate


pip install -e .

Development install

Same as source, but includes test and lint tooling.

Terminal window
pip install -e ".[dev]"

This pulls in pytest, pytest-cov, and ruff.

From a Git tag / branch directly

Terminal window
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

[project]
dependencies = [
  "medix>=1.3.0",
]

Verify the install

Terminal window
medix --version

You should see the installed version printed. You can also invoke Medix as a module:

Terminal window
python -m medix --version

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:

Terminal window
# macOS
brew install ffmpeg


# Ubuntu / Debian
sudo apt install ffmpeg


# Fedora
sudo dnf install ffmpeg


# Arch
sudo pacman -S ffmpeg


# Windows (winget)
winget install Gyan.FFmpeg

See FFmpeg Auto-Install for the full list.

Next steps