release-script

This documentation is a WIP (Work in Progress)...

Local Development

• Setup a new venv (if not done already)

  python3 -m venv venv

• Source it

  source venv/bin/activate

• Install the project dependencies:

  pip install -r test.requirements.txt -r requirements.txt

• Run tests locally:

  pytest --cov=src

• Run code linting, to detect wrong code or bad practices

  flake8 ./src --count --show-source --statistics

• Run security tests

  bandit -r . --ll -ii -x ./test -x ./venv