cookiecutter-django-package

Cookiecutter template for a Django package adapted from Hypermodern Python Cookiecutter from Claudio Jolowicz.

✨📚✨ Read the full documentation

Usage

cookiecutter gh:OmenApps/cookiecutter-django-package --checkout=2024.05.3

Features

• Packaging and dependency management with Poetry
• Test automation with Nox
• Linting with pre-commit and Flake8
• Continuous integration with GitHub Actions
• Documentation with Sphinx, MyST, and Read the Docs using the furo theme
• Automated uploads to PyPI and TestPyPI
• Automated release notes with Release Drafter
• Automated dependency updates with Dependabot
• Code formatting with Black and Prettier
• Import sorting with isort
• Testing with pytest and pytest-django
• Testing with Docker Compose (optionally using PlayWright
• Code coverage with Coverage.py
• Coverage reporting with Codecov
• Command-line interface with Click
• Automated Python syntax upgrades with pyupgrade
• Security audit with Bandit and Safety
• Check documentation examples with xdoctest
• Generate API documentation with autodoc and napoleon
• Generate command-line reference with sphinx-click
• Manage project labels with GitHub Labeler
• Optionally run an instance of Postgresql and the example project (with your django package installed locally) using Docker Compose

The template supports Python 3.9, 3.10, 3.11, and 3.12.