aubricus / cookiecutter-python-package

A Python Package CookieCutter Template

CookieCutter Python Package

A Python Package CookieCutter Template

Background

This Python package CookieCutter template is a boilerplate for my own personal projects. It should be useful for micro to small sized Python packages intended for light automation and scripting tasks.

Install

Dependencies

• Python 3.6, 3.7, 3.8 (pyenv recommended)
• CookieCutter

Installation

$ pip install -U cookiecutter

Usage

$ cookiecutter gh:aubricus/cookiecutter-python-package

Features

This CookieCutter generates a Python Package boilerplate.

Template Features

• Supports a .donotrender extension to declaritively exempt files from CookieCutter

Boilerplate Features

• Outputs a sensible README.md using the Standard README format.
• Outputs lightweight CHANGELOG.md, CONTRIBUTING.md
• Outputs a LICENSE file generated by GitHub API
• Outputs a CODE_OF_CONDUCT file generated by GitHub API
• Outputs a sensible .gitignore from gitignore.io
• Outputs lightweight GitHub issue & pull-request templates
• Supports pytest & coverage for testing
• Supports tox and simple CI with GitHub Actions
• Supports Poetry for dependencies, packaging, and publishing
• Supports Pdoc3 for documentation generation with support for GitHub Pages
• Supports Black & pydocstyle for formatting & linting
• Supports Click & klak for local project automation

Support

• Python 3.6, 3.7, 3.8
• MacOS: Tested locally, Python 3.6.9 via pytest
• Linux: Ubuntu Latest, Python 3.6, 3.7, 3.8 via GitHub Actions
• Windows: Not tested. ☹️

Maintainers

• aubricus

Attribution

This template was generated with cookiecutter/cookiecutter and aubricus/cookiecutter-cookiecutter!

Contributing

Issues & pull-requests accepted. See the CONTRIBUTING.md

Small note: If editing the README.md, please conform to the standard-readme specification.

License

MIT © Aubrey Taylor 2020

cookiecutter-python-package's Issues

Fix Typo in Issue Template

• Update - Observed Behaivor to - Observed Behavior

Fix Package Name in Issue Template

• Upate - System Info (OS, Python Version, CookieCutter-CookieCutter Version) to `- System Info (OS, Python Version, cookiecutter-python-package Version)

List Poetry (at current build) as a Dependency to Run Template

Since the template relies on poetry to be installed (to dynamically create the pyproject.toml) this template will likely fail if poetry is not installed.