Developing on local PC

How to contribute

Setup environment

1. Install pyenv.

2. Prepare interpreter

$ pyenv install 3.12
$ pyenv shell $(pyenv latest 3.12)

3. Install dependencies

$ pip install -U poetry
$ poetry config virtualenvs.in-project true && poetry install && source .venv/bin/activate

4. 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 generate local documentation, use:

$ inv docs.build

To clear local documentation, use:

$ inv docs.clear