Contribute

To contribute to developing this package, check out its GitHub repository and push commits there.

Dependency Management

We use uv for resolving and installing dependencies. For an overview of the basic uv commands, visit the official documentation.

1. Install uv.

2. Install the dependencies with uv sync --all-extras --group docs. uv creates a virtual environment in .venv.

3. You can run commands in the virtual environment with uv run [command].

4. When adding new dependencies, use uv add [my-package]. Use uv add --dev [my-package] for a development dependency or uv add --group docs [my-package] for a documentation dependency.

5. Commit pyproject.toml and uv.lock in a PR when dependencies change. Once merged into main, GitHub Actions will build the image with the new dependencies.

Tests

You can run tests by executing uv run pytest -n auto.

Build the documentation locally

Running uv run sphinx-build -b html ./docs ./docs/_build/html from the repository root will generate the documentation.