Skip to content

Installation

Once you've downloaded the source code, you can install the library with Pip:

❯ pip install .

Preferably, you would create a dedicated virtual Python environment first, with python -m venv.

If you're using UV to manage Python projects (recommended), you don't actually need to explicitly install the package, as UV will handle that transparently as long as you prefix commands with uv run. Find examples in the Makefile.

But to make sure everything will work, you can trigger the creation of the virtual environment (in the .venv folder) and installation of project dependencies with:

❯ uv sync