Hypermodern Python for ML Cookiecutter

[![Codecov][codecov badge]][codecov page]
[![Contributor Covenant][contributor covenant badge]][code of conduct]

Cookiecutter template for a Machine Learning project in Python, based on the Hypermodern Python Cookiecutter by Claudio Jolowicz as well as the Data Science Cookiecutter by DrivenData.

This is a very opinionated template, designed to guide the user in creating a ML project that will be easy to test, maintain, update and deploy.

Usage

$ cookiecutter gh:mdsach/cookiecutter-hypermodern-python-ml \
  --checkout=""

Features

• Packaging and dependency management with Poetry

• Test automation with Nox

• Linting with pre-commit and Flake8

• Documentation with Sphinx and MyST using the furo theme

• Automated release notes with Release Drafter

• Code formatting with Black

• Import sorting with isort

• Testing with pytest

• Code coverage with Coverage.py

• Static type-checking with mypy

• Runtime type-checking with Typeguard

• Automated Python syntax upgrades with pyupgrade

• Security audit with Bandit and Safety

• Check documentation examples with xdoctest

• Generate API documentation with autodoc and napoleon

The template supports Python 3.9, and 3.10.