Cookiecutter Pypackage
Cookiecutter template creating a Python package with mkdocs
Overview:
Cookiecutter PyPackage is a Python package template that streamlines the process of creating, testing, versioning, and releasing Python packages. It comes with various key features designed to simplify package development and deployment. This analysis will delve into its features, installation guide, and usage instructions.
Features:
- Testing Setup: Includes setup with unittest and python setup.py test or pytest.
- GitHub Actions: Ready for GitHub Continuous Integration testing.
- Version Bumping: Pre-configured version bumping with a single command.
- Auto-release to PyPI: Automatically release to PyPI when a new tag is pushed to master.
- Command Line Interface: Optional usage of Click for a command line interface.
Summary:
The Cookiecutter PyPackage template provides a structured approach to creating Python packages by offering features like testing setup, GitHub Actions integration, version bumping, auto-release to PyPI, and a command line interface. By following the outlined installation guide and usage instructions, developers can streamline the process of creating, testing, versioning, and releasing Python packages efficiently.