Developer Guide

PDM

This project is utilizing PDM as its package manager for managing dependencies and ensuring consistent and reproducible environments. See PDM’s documentation for details on installing PDM.

Installing developer dependencies

pdm sync -d

Running the unit-tests

pdm run pytest

Coverage report

pdm run coverage report

Checking and formatting of code

pdm run ruff format
pdm run ruff check --fix
pdm run mypy

Building the documentation

pdm run sphinx-build ./docs/source ./docs/build

Building the package

pdm build