cogra
GitHub

Contributing

Thank you for helping. Questions, bugs and ideas are welcome as issues. For a new style, wear look or paper layout, please open an issue to talk it over before you start a pull request.

Setting up

cogra uses uv for its environment.

uv sync --extra dev          # creates .venv from uv.lock, with the test and lint tools
uv run pre-commit install    # ruff and a secret scan run on every commit

Before a pull request

uv run ruff check src tests examples      # lint
uv run ruff format src tests examples     # format
uv run mypy                               # type check the package
uv run pytest --cov                       # tests, with coverage

CI runs the same four steps on Python 3.10 (with the oldest supported matplotlib), 3.12 and 3.13.

Releasing (maintainer)

  1. Update version in pyproject.toml and CITATION.cff (semantic versioning: patch for fixes, minor for new features, major for breaking changes) and date the entry in CHANGES.md.
  2. uv lock, commit, and make a GitHub release tagged v<version>. Zenodo archives each release and gives it a DOI once the repository is switched on at zenodo.org.
  3. uv build and uv publish to put it on PyPI.