/acutter

A cookiecutter template for Python package with heavy use of Github actions

Primary LanguagePythonMIT LicenseMIT

Cookiecutter PyPackage

release

Cookiecutter template badge

Cookiecutter template for a Python Project. This is good both for libraries and applications (just delete features that you don't need).

Features

The newly cut project will have those:

  • Uses pyproject.toml.
  • Provides automatically generated setup.py (to work around current tooling defficiencies).
  • Testing with Pytest (locally and using Github actions).
  • Follows the black style guide with flake8 and isort.
  • Style guide enforced on CI.
  • Follow to the conventional commits specification.
  • Automated releasing using python-semantic-release.
  • Documentation configured with Sphinx and MyST Parser.
  • Standardised list of GitHub labels synchronised on push to master using the labels CLI.
  • VSCode settings
  • When used locally: ability to upgrade/convert existing projects/libraries

Credits

This package was created with Cookiecutter and the browniebroke/cookiecutter-pyproject project template.