Cookiecutter PyPackage

This package contains a Cookiecutter template for a Python package. It implements my preferred style guidelines, and automates the setup of test suites, CLI interfaces, CI/CD pipelines, and documentation.

Usage

To use this template, you need to have Cookiecutter installed. If you don't have it installed, you can install it using pip:

$ pip install cookiecutter

To use pre-commit hooks which ensure code compliance before allowing commits (as is default), you also need to install pre-commit:

$ pip install pre-commit

Afterwards, you can generate a new Python package using this template by running the following command:

$ cookiecutter git@github.com:LokiLuciferase/cookiecutter-pypackage.git

This will prompt you to enter some information about your package, such as the package name, author name, and license. After providing the required information, Cookiecutter will generate a new directory with the project structure and files for your Python package.

Documentation