🐍🍪 Group4Life Cookie

A Python Cookiecutter tailored towards Group4Life projects

Quickstart¤

Install the latest Cookiecutter

pip install -U cookiecutter

and generate a Python package project:

cookiecutter gh:Group4Life/cookie

Dependency tracking using Poetry.
Multi-version documentation extracted from source code provided by MkDocs, mkdocstrings, Material for MkDocs and mike and hosted on GitHub Pages.
Automated dependency and security updates with Renovate and Dependabot.
Formatting provided by black and isort.
Testing setup with pytest.
Coverage reports with Coverage.py and Codecov.
Static type checking by mypy.
Security checks with CodeQL.
Linting provided by Ruff.
Git hooks managed by pre-commit.
Development tasks (lint, format, test, etc) provided by Poe The Poet.
CI facilitated by Github Actions.
Automated CHANGELOG generation, GitHub releases and PyPI releases facilitated by Python Semantic Release.
Preview documentation changes introduced via a PR on surge.
Automatically fix typos in your source code and documentation via Misspell Fixer.
Beautiful YAML issue templates.
Informative PR template and Security Policy.
Add informative comments on issues & PRs based on assigned labels using Label Commenter.
Manage project labels with GitHub Labeler.
Ready-to-use .editorconfig and .gitignore.
Be always ready to code using GitHub Codespaces.

The template supports Python 3.7 or higher.

Before contributing to the project, please go through the Contributing Guidelines first.

The project's documentation can be found here.