README.md

Cookiecutter Template for Python Project

This is a basic template with minimal features.

Features

• poetry for package management
• pre-commit hooks:
  • Linting with flake8 (+ plugins)
  • Remove unused imports and variables with autoflake
  • Sorting imports with isort
  • Code formatting with black
  • Docstrings formatting with docformatter
  • Static type checking with mypy
• pytest + pytest-cov + pytest-mock
• sphinx + sphinx-autoapi for automatic API documentation
• github actions:
  • Run pre-commit checks on PRs
  • Run pytest on commits and PRs

Setup

Install cruft or cookiecutter

cruft create <url>

or

cookiecutter <url>