Contributing

Before making changes create a virtual environment

python -m venv venv

Notice that a /venv directory is created in the project folder. Activate the virtual environemnt:

source ./venv/bin/activate

Next, install package using with -e flag for development

python -m pip install -e .

Run test:

pytest

Build

Install build

python -m pip install --upgrade build

Build package project

python -m build

You’ll need to install Twine:

python -m pip install --upgrade twine

For test distribution use testpypi:

python -m twine upload --repository testpypi dist/*

Install setuptools-git-versioning:

pip install setuptools-git-versioning

Checking dirty and beta versions for project using setuptools-git-versioning

Run:

python -m setuptools_git_versioning