CONTRIBUTING.md

Dependency management

You need to have virtualenv installed globally. In case you don't, run:

pip install virtualenv

Create and activate a virtualenv (name it .venv).

python -m venv .venv
source .venv/bin/activate

You should now see the prefix (.venv) in your terminal prompt. This means the virtualenv is active.

Install locally

Install default and test requirements (assure .venv is active).

pip install -e .[test]

Run tests.

python -m pytest

Publish to Pypi

A GitHub Action will publish the package whenever a new git tag is pushed to origin.

Run the following command to roll out a new patch|minor|major version and push it to origin.

./rollout.sh

When prompt Push changes?, type y.