Python Project Template

Features

Github workflows

• Running pre-commit hooks.
• Running pre-commit autoupdate monthly.
• Finding security vulnerabilities with CodeQL.

pre-commit

Improving code quilicty with pre-commit hooks.

Code style: black.

Static analysis: flake8, mypy.

Python documentation: pydocstyle, doctest.

Shell script: shellcheck.

Markdown: markdownlint

YAML: yamllint

Jupyter notebook: nbQA

Git commit style: conventional commits

Development Guide

Install Python venv with pipenv.

python3 -m pip install pipenv
pipenv sync --dev

Install pre-commit hooks into Git.

pipenv shell
pre-commit install
pre-commit install -t commit-msg