README.md

My Package

A short description of what my-package does.

Getting started from this template

• Rename src/mypackage/ to your package name
• Update pyproject.toml: name, description, authors, Python classifiers, and --cov=mypackage in addopts
• Update [tool.coverage.run] source in pyproject.toml
• Update docs/conf.py: change the distribution() call to your package name
• Update docs/api.rst: change automodule:: mypackage to your package name
• Update .github/ISSUE_TEMPLATE/bug_report.md: replace my-package version with your package name
• Update CONTRIBUTING.md: replace the clone URL and package name
• Update this README.md: replace all references to my-package / mypackage with your package name and remove this checklist
• Enable GitHub Pages (Settings → Pages → Deploy from gh-pages branch)
• Set up Codecov for your repository
• Configure PyPI trusted publishing if you plan to publish

Installation

pip install my-package

Or with uv:

uv pip install my-package

Quick Start

import mypackage

# Example usage here

Documentation

Full documentation is available at ml4gw.github.io/my-package.

Contributing

See CONTRIBUTING.md for development setup and contribution guidelines.

License

GNU General Public License v3