• Python 3.8 or newer

This project uses poetry for packaging and managing all dependencies and pre-commit to run flake8, isort, mypy and black.

Additionally, pdbpp and better-exceptions are installed to provide a better debugging experience. To enable better-exceptions you have to run export BETTER_EXCEPTIONS=1 in your current session/terminal.

Clone this repository and run

pip install poetry

poetry install
poetry run nbstripout --install
poetry run pre-commit install

to create a virtual enviroment containing all dependencies.

You can run the test suite using

poetry run pytest

This repository follows the Conventional Commits style.

This project was created using cruft and the cookiecutter-jupyter template. In order to update this repository to the latest template version run

cruft update

in the root of this repository.