/soft-cookiecutter

Cookiecutter template for easy python packaging.

Primary LanguagePython

Everything you need for a modern python project/package.

See cookiecutter and cruft for more informations.

Usage

pip install -y cookiecutter cruft
cruft create https://github.com/gjeusel/soft-cookiecutter

Details

Tooling choices

  • PEP 621: pyproject.toml (everything)
  • Hatchling: dynamic versioning (based on git)
  • pre-commit: a framework for managing and maintaining multi-language pre-commit hooks
  • mkdocs: generate beautiful documentation easily with mkdocs-material

CI Github actions

  • Linter & Formatter: ruff
  • Type Checker: mypy
  • Pytest: unit testing
  • Code Coverage: coverage & smokeshow
  • PyPI: deployment only on new tag in main branch