11. Developer’s Guide

Running Tests

To run tests, ensure you are at the root of the project directory.

Install Dependencies

pip install -e ".[dev]"

Run Tests

pytest tests

or

make test

Coverage Report

make test-cov

Building Documentation Locally

Install Dependencies

pip install ".[dev]"
cd docs
pip install -r requirements.txt

Update Changelog

make update-docs-changelog

Serve Documentation

make clean && make docs

This will build the documentation in docs/_build

Linting

Get Pylint Score

make lint

Update Linting Score Badge

make update-lint-score

Code Formatting

The following command will use black with a line length of 108 on directories that contains the main code sources:

make code-formatting

Security Check

Run a security check using Bandit:

make bandit