Template Python repository

This is a template Python repository.

Repository structure:

.github: Github Actions for Continuous Integration
docs: Jupyter-book (auto-generated) documentation
notebooks: Jupyter notebooks
requirements: Python requirement files and their pinned versions
src: The main codebase
tests: Unit and Integration tests
tools: Tools for managing the repository

Features:

Jupyter-book: Documentation generator using Markdown, Jupyter, and Sphinx
pip-compile-multi: Python requirement and dependency locking
Git pre-commit hooks
- codespell: Check for common misspellings in text files.
- black: Automatic code formatting
- isort: Automatic sorting of Python imports
- nbstripout: Automatic stripping of notebook output
- License checking, which uses:
  - pip-licenses: Get license info using pip
  - pipdeptree: Get pip dependency tree
- and more: File size checking, remove trailing whitespace, ..
Continuous Integration based on Github Actions, using:
- mypy: Python type checker
- pytest unit and integration testing
  - pytest-cov: Pytest coverage checker
  - pytest-clarity: Pytest improved readability
- pycodestyle: Python PEP8 style checker
- pylint: Python linter
- Docstring checkers/linters
  - darglint: Python docstring linter
  - interrogate: Python docstring coverage checker
  - pydocstyle: Python docstring style checker
- shellcheck: Shell file linter
- container-scan: Scan Docker container for vulnerabilities using Trivy and Dockle
  Note: The vulnerability scan can be activated by uncommenting the section in tools/Dockerfile.

Future enhancements:

Look into compressing Docker container using conda-pack.

Development

Setup after cloning this repository

Setup a conda environment (replace <env_name> with a suitable name):
conda env create -n <env_name> -f requirements.yml
This sets up an environment to track and encapsulate the dependencies of the project.
When working on this project switch to the environment first, using:
conda activate <env_name>
To exit the environment use: conda deactivate <env_name>
Install the git pre-commit hooks:
pre-commit install
This will perform sanity checks and format your code before git adds the (updated) files to the git repository.
Change the information in setup.cfg, such as, the project and package names, copyright, author, release version, license, etc.
Change the information in docs/_config.yml to update the project name, copyright, author, version, etc.
Change any settings in pyproject.toml, such as the folder for pytest coverage to check addopts = "--cov=<folder> --no-cov-on-fail".

Workflow

Tracking requirements and their dependencies

To keep track of requirements, add them to the requirements/base.in file in the appropriate section.
After adding or removing requirements, the requirements and their dependencies can be pinned to specific versions by running:
pip-compile-multi
This will pin all requirements and dependencies to specific versions in the requirements/*.txt files for reproducibility.
The base file contains deployment dependencies, while the dev file contains development dependencies.

Style and Continuous Integration checks/formatters

Local (pre-commit) checks and formatters

To run the local pre-commit checks, execute:
pre-commit run
Note: Only staged files will be checked.

To run on all git-tracked files in the repository: pre-commit run --all-files or pre-commit run -a.
Note: This will still not run on untracked files. First stage any untracked/modified files you which to check.
The local pre-commit checks are run using pre-commit based on the configuration in .pre-commit-config.yaml.

For convenience, it is possible to run a single check, for example, for pylint use pre-commit run pylint.

Continuous Integration checks and formatters

To manually and locally run all CI checks, run:
./tools/ci_checks.sh
The script will check all files in the git repository.

For convenience, it is possible to run a single check, for example, for mypy:
./tools/ci_checks.sh mypy

The CI checks are run using pre-commit based on the configuration in tools/ci-pre-commit-config.yaml.

Turn off checking on a function/per-line basis

In some cases it is needed to disable some of the checkers on a function/per-line basis.
Below is a list of comments to disable the checkers.
Use these sparingly and only if absolutely necessary!

Pylint: # pylint: disable=<error_name>
Black formatter: Create a # fmt: off and # fmt: on block.
isort: # isort:skip
Pycodestyle: # noqa or "# noqa: <error_numbers>
Pydocstyle: # noqa or # noqa: <error_numbers>
darglint: # noqa: <error> <argument>
mypy: # type: ignore
Pytest coverage: # pragma: no cover

Building the documentation

To build the documentation run:

jupyter-book build docs

The documentation will be output in docs/_build/html. Add --all to rebuild all docs from scratch instead of using cached files.

To create a pdf file of the docs:

jupyter-book build --builder pdflatex docs

Note: The above requires installing LaTeX.

To push the documentation to Github Pages, see this link.

jvanheugten/template