Introduction

A copier-based template for Python packages.

Features

• 📦 Package management: Test, build, and deploy your package with Hatch environments.
• 📚 Documentation: Document your package in MyST or MkDocs.
• 🧹 Pre-commit: Format and lint your code with Ruff.
• ⚙️ GitHub Actions:
  • Deploy documentation to GitHub Pages or Read the Docs.
  • Run pre-commit checks and tests on every pull request.

Usage

Follow the copier installation instructions. Then simply run

copier copy https://github.com/mbercx/python-copier <package_name>

And answer the questions to generate a new Python package.

Next steps

After copying the template, you might still have to do some additional configuration.

Deploy documentation

Read the Docs

1. Push your code to GitHub.
2. Go to Read the Docs (RTD) and import your project. The build will use the included .readthedocs.yaml automatically.
3. Set the RTD settings to build from GitHub pull requests.