Cookiecutter PyPackage

Cookiecutter template for a Python package. Powered by Poetry, GitHub actions, and MkDocs-Material.

Features

This template has the following features:

pytest: Unit and coverage testing
flake8 and pylint: Python style checks
black: Auto-formatted code
mypy: Type checking
Poetry: Depedency managemnt and packaging
GitHub Actions: Automated CI checks, auto-release to PyPi, and automated version bumping (no more Travis needed)
MkDocs-Material: Auto-publish documentation to it's own webpage

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):

$ pip install -U cookiecutter>=1.4.0

Generate a Python package project:

$ cookiecutter https://github.com/mgancita/cookiecutter-pypackage.git

Further Information about how to use this template could be found in the official documentation

Name		Name	Last commit message	Last commit date
Latest commit History 71 Commits
.github		.github
docs		docs
hooks		hooks
tests		tests
{{cookiecutter.project_slug}}		{{cookiecutter.project_slug}}
.editorconfig		.editorconfig
.flake8		.flake8
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
cookiecutter.json		cookiecutter.json
mkdocs.yml		mkdocs.yml
mypy.ini		mypy.ini
poetry.lock		poetry.lock
poetry.toml		poetry.toml
pyproject.toml		pyproject.toml
pytest.ini		pytest.ini