Python Project Template
This repository provides a python project template to be used with cookiecutter.
Features
- Dependency and packaging management with Poetry
- Testing setup with pytest
- Test coverage using pytest-cov
- Automated quality checks with pre-commit
- Linting with flake8
- Automated formatting with Black
- Optional mypy type checking
- Optional pydantic configuration
- Optional CI/CD Github Action workflow
- CI: tests, pre-commit checks and documentation building
- CD: automated semantic versioning and publishing to a python repository
- Optional HTML documentation build with Sphinx
Prerequisites
To use this template you will first need to install:
Usage
To create a new project out of this template, simply run:
cookiecutter https://github.com/rdguez-mariano/python-project-template