This repository serves as a template for software projects.
Using pre-commit
hooks, flake8
, black
, mypy
, docformatter
, pydocstyle
and pytest
are locally run on every commit. For more details on how to use pre-commit
hooks see here.
Similarly, Github actions are used to run flake8
, black
, mypy
, docformatter
, pydocstyle
and pytest
on every push and pull request and merge to main. The pytest
also runs coverage. GitHub actions are explained in detail here.
For GitHub actions/CI Setup see here