Skip to content

Developing on local PC

How to contribute

Setup virtual environment

We use uv to manage the dependencies.

To set up venv you would need to run sync command:

uv sync --all-packages --all-groups --all-extras

To activate your virtualenv

source .venv/bin/activate

Init project

inv project.init

Style checks

Note

For common actions in the project used invoke.

We use pre-commit for quality control. To run checks:

inv pre-commit.run-hooks

Local Documentation

To build local documentation, use:

inv docs.build

To serve built documentation on localhost, use:

inv docs.serve