CookieRiver: Cookiecutter Template for HyRiver Software Development

This is a Cookiecutter template for HyRiver software development. It generates a project structure with the following features:

• A Python package with a command-line interface (CLI) using Click
• A test suite using pytest
• Continuous integration (CI) using GitHub Actions
• Code coverage using Codecov
• A README template with badges for CI, code coverage, and PyPI
• An MIT LICENSE file
• Contribution and Code of Conduct guidelines
• A pyproject.toml file
• Linting, formatting, and type checking using pre-commit, pyright, and nox

Usage

First, install cookiecutter:

pipx install cookiecutter

Then, generate a new project:

cookiecutter gh:hyriver/cookieriver