Developer’s Guide

Running Tests

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

Install Dependencies 

pip install ".[dev]"

Run Tests 

pytest tests

or

make test

Coverage Report 

make test-cov

Building Documentation Locally

Install Dependencies 

pip install ".[dev]"

Update Changelog 

make update-docs-changelog

Install Ruby and Bundler

Install Ruby Dependencies 

cd docs
bundle install

Serve Documentation 

bundle exec jekyll serve

This will build the documentation and provide an address like http://127.0.0.1:4000/.

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