sutch / cookiecutter-python-app

Cookiecutter template for a Python application project.

Python Application Project Template

This is a Cookiecutter template for creating a Python application project.

The project layout is based on the Python Packaging User Guide. The current conventional wisdom forgoes the use of a source directory, but moving the package out of the project root provides several advantages (cf. Packaging a Python library).

The py27 branch is for Python 2.7 compatibility; it is no longer actively maintained.

Project Features

• Python 3.5+
• MIT License
• pytest test suite
• Sphinx documentation

Application Features

• CLI with subcommands
• Logging
• Hierarchical YAML configuration

Usage

Install Python requirements for using the template:

$ python -m pip install --user --requirement=requirements.txt

Create a new project directly from the template on GitHub:

$ cookiecutter gh:mdklatt/cookiecutter-python-app