Skip to content

README.md

Latest commit

 

History

History
42 lines (33 loc) · 988 Bytes

README.md

File metadata and controls

42 lines (33 loc) · 988 Bytes

python-cookiecutter

This is a cookiecutter repo to bootstrap Python projects - either an installable package or an AWS Lambda.

Out of the Box

  • Could be either a lambda or a standard python package
  • CI ready - see README.md in generated repo
  • tox manages testing and releasing
  • pytest test runner
  • Coverage reporting and enforcement
  • Enforce black formatting
  • Enforce flake8

Requirements

Install cookiecutter and tox:

pip install cookiecutter tox

You might need to run a pyenv rehash so the command-line utils become available:

pyenv rehash

Usage

Generate a new Cookiecutter template layout:

cookiecutter gh:hmrc/python-cookiecutter

Testing

There's a miniature test suite that can be run before merging changes:

cd tests/
./test.sh

License

This code is open source software licensed under the Apache 2.0 License.