Development Guide¶

Make sure you have poetry installed. To set up the development environment, run the following command to install the project’s dependencies.

with development and documentation tools

# in the shell
poetry install --with dev,docs

only development tools

# in the shell
poetry install --with dev

Tip

The --with dev flag installs the development dependencies, which includes the pytest test runner, mypy static type checker, and the black code formatter.

Tip

The --with docs flag installs the documentation dependencies, which includes the Sphinx documentation generator and extensions and themes for it.

Running the tests¶

# in the shell
poetry run pytest

Running the static type checker¶

# in the shell
poetry run mypy src

Formatting the code¶

# in the shell
poetry run black src

Building the documentation¶

To build the documentation, the project’s docs dependency group must be installed.

# in the shell
poetry install --with docs

# in the shell
poetry run sphinx-autobuild docs docs/_build/html --watch src