Skip to content

lmarsden/cookiecutter-pypackage

 
 

Repository files navigation

Cookiecutter PyPackage

Python Package

Cookiecutter template for a Python package.

Features

  • Makefile for orchestrating
  • Testing setup with pytest
  • Linting setup with flake8, isort and black
  • GitHub Actions: Ready for Continuous Integration testing with GitHub Actions
  • Tox testing: Setup to easily test for Python 3.6, 3.7, 3.8
  • Sphinx docs: Documentation ready for generation
  • bump2version: Pre-configured version bumping with a single command

Quickstart

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

pip install -U cookiecutter

Generate a Python package project:

cookiecutter https://github.com/UKHO/cookiecutter-pypackage.git

Then create a repo and put it there.

GitHub Actions should automatically start working once the code has been pushed up.

About

Cookiecutter template for a Python package.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 73.5%
  • Makefile 26.5%