uv-first docs, PyPI/GitHub README parity, and automatic carry-at-9 versioning (#26)

- README: lead with uv (uv add / uv sync), keep pip as a documented fallback;
  convert image/file links to absolute URLs so the PyPI long-description (which
  is README.md) renders identically to GitHub
- docs/README.md: sync to the canonical README (was stale: old rigged LQR
  comparison and figures)
- tools/bump_version.py: increment the version with single-digit carry-at-9
  components (2.0.9 -> 2.1.0, 2.9.9 -> 3.0.0), updating pyproject.toml and
  __init__.py together
- publish workflow: auto-increment the version (commit to master) before
  building/publishing/releasing, so every release bumps automatically
- CONTRIBUTING: document the auto-bump release flow
- CLAUDE.md: record the uv-first + carry-at-9 versioning conventions


Claude-Session: https://claude.ai/code/session_013KvuS9HKbnZAwwFJyBkyHc

Co-authored-by: Claude <noreply@anthropic.com>

Author: krichelj

.github/workflows/python-publish.yml

@@ -1,13 +1,14 @@
-# Publishes the package to PyPI and creates the matching GitHub Release.
+# Publishes the package to PyPI and creates the matching GitHub Release,
+# auto-incrementing the version each run.
 #
-# Flow: bump `version` in pyproject.toml, then run this workflow
-# (Actions -> Upload Python Package -> Run workflow). It builds the dists,
-# uploads them to PyPI via Trusted Publishing, and creates a GitHub Release
-# tagged v<version> with auto-generated notes and the dists attached.
+# Flow (just run it — Actions -> Upload Python Package -> Run workflow):
+#   1. bump-version  : increment the version (carry-at-9 via tools/bump_version.py),
+#                      commit it back to master.
+#   2. release-build : build the dists from the bumped master.
+#   3. pypi-publish  : upload to PyPI via Trusted Publishing (OIDC, no tokens).
+#   4. github-release: create the v<version> GitHub Release with notes + dists.
 #
-# It is idempotent: re-running for an already-published version skips the PyPI
-# upload (skip-existing) and updates the existing release's assets, so it is
-# safe to run against the current version to backfill a release.
+# Versions roll over at 9: 2.0.9 -> 2.1.0, 2.9.9 -> 3.0.0.
 
 name: Upload Python Package
 
@@ -18,11 +19,39 @@ permissions:
   contents: read
 
 jobs:
-  release-build:
+  bump-version:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      version: ${{ steps.bump.outputs.version }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: master
+
+      - name: Increment the version (carry-at-9)
+        id: bump
+        run: |
+          new="$(python3 tools/bump_version.py)"
+          echo "version=$new" >> "$GITHUB_OUTPUT"
+          echo "Bumped to $new"
+
+      - name: Commit and push the bump
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml src/PyDiffGame/__init__.py
+          git commit -m "chore: bump version to ${{ steps.bump.outputs.version }} [skip ci]"
+          git push origin HEAD:master
 
+  release-build:
+    needs: bump-version
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
+        with:
+          ref: master  # the bumped commit
 
       - name: Install uv
         uses: astral-sh/setup-uv@v6
@@ -37,9 +66,9 @@ jobs:
           path: dist/
 
   pypi-publish:
-    runs-on: ubuntu-latest
     needs:
       - release-build
+    runs-on: ubuntu-latest
     permissions:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
@@ -66,15 +95,18 @@ jobs:
           skip-existing: true
 
   github-release:
-    runs-on: ubuntu-latest
     needs:
+      - bump-version
       - pypi-publish
+    runs-on: ubuntu-latest
     permissions:
       # Needed to create the release and its tag.
       contents: write
 
     steps:
       - uses: actions/checkout@v5
+        with:
+          ref: master
 
       - name: Retrieve release distributions
         uses: actions/download-artifact@v5
@@ -85,9 +117,9 @@ jobs:
       - name: Create or update the GitHub Release
         env:
           GH_TOKEN: ${{ github.token }}
+          VERSION: ${{ needs.bump-version.outputs.version }}
         run: |
-          version="$(grep -m1 '^version' pyproject.toml | sed -E 's/version *= *"([^"]+)".*/\1/')"
-          tag="v${version}"
+          tag="v${VERSION}"
           echo "Releasing ${tag}"
           if gh release view "$tag" >/dev/null 2>&1; then
             echo "Release ${tag} already exists - refreshing its assets."
@@ -96,5 +128,5 @@ jobs:
             gh release create "$tag" dist/* \
               --title "$tag" \
               --generate-notes \
-              --target "$GITHUB_SHA"
+              --target master
           fi

CLAUDE.md

@@ -0,0 +1,32 @@
+# PyDiffGame — repository guide for Claude
+
+## Python tooling (uv-first)
+- Use **uv** for everything; pip is only a documented fallback.
+  - `uv sync --extra dev`, `uv run pytest`, `uv run ruff check`, `uv run ruff format`,
+    `uv run mypy src/PyDiffGame`, `uv build`.
+- Keep the quality gates green before committing: ruff format, ruff check, mypy on
+  `src/PyDiffGame`, and the pytest suite — all via `uv run`.
+
+## Versioning (carry-at-9)
+- The version is `X.Y.Z` with single-digit components that roll over at 9:
+  `2.0.9 -> 2.1.0`, `2.9.9 -> 3.0.0` (the major keeps growing).
+- Increment **only** via `tools/bump_version.py`, which updates the version in both
+  `pyproject.toml` and `src/PyDiffGame/__init__.py`. Never hand-edit version strings.
+- The version is bumped **automatically** by the publish workflow on each release, so
+  do not bump it in ordinary PRs — the release run does it.
+
+## Releasing
+- `Actions -> Upload Python Package -> Run workflow` (on `master`). The workflow
+  auto-increments the version, commits it to `master`, builds with `uv build`,
+  publishes to PyPI via Trusted Publishing (OIDC, no tokens), and creates the matching
+  `v<version>` GitHub Release with notes and the built dists attached. It is idempotent
+  (`skip-existing`).
+
+## Docs
+- `README.md` is the single canonical readme and is also the PyPI long-description
+  (`pyproject.toml: readme = "README.md"`), so its image/file links must be **absolute**
+  (`raw.githubusercontent.com/.../master/...` for images, `github.com/.../blob/master/...`
+  for files) so they render on PyPI.
+- Keep `docs/README.md` identical to `README.md`.
+- README figures are generated from the live solver:
+  `uv run python tools/generate_readme_figures.py`.

CONTRIBUTING.md

@@ -41,22 +41,26 @@ they pass locally.
 
 ## Releasing
 
-Publishing a new version to PyPI and creating the matching GitHub Release is a
-single automated step:
+Publishing a new version is a single automated step — just run the publish
+workflow: **Actions -> Upload Python Package -> Run workflow** (on `master`).
 
-1. Bump `version` in `pyproject.toml` (e.g. `2.0.0` -> `2.1.0`) and merge it to
-   `master`.
-2. Run the publish workflow: **Actions -> Upload Python Package -> Run workflow**
-   (on `master`).
-
-That run builds the distributions with `uv build`, uploads them to PyPI via
-[Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC — no
-tokens or secrets), and then creates a `v<version>` GitHub Release with
-auto-generated notes and the built wheels/sdist attached.
+The run automatically:
 
-The workflow is idempotent: re-running it for a version already on PyPI skips
-the upload (`skip-existing`) and just refreshes the release assets, so it is
-safe to re-run.
+1. **Increments the version** with `tools/bump_version.py`, which rolls each
+   component over at 9 (`2.0.9 -> 2.1.0`, `2.9.9 -> 3.0.0`), updating both
+   `pyproject.toml` and `src/PyDiffGame/__init__.py`, and commits the bump to
+   `master`.
+2. Builds the distributions with `uv build`.
+3. Uploads them to PyPI via
+   [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC — no
+   tokens or secrets).
+4. Creates a `v<version>` GitHub Release with auto-generated notes and the built
+   wheels/sdist attached.
+
+You normally never edit the version by hand. To bump it locally (e.g. to test),
+run `uv run python tools/bump_version.py` (`--dry-run` to preview, `--current`
+to print the current version). The PyPI upload is idempotent (`skip-existing`),
+so re-running the workflow is safe.
 
 Thank you for your contribution!
 

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img alt="PyDiffGame logo" src="images/logo.png" width="420"/>
+    <img alt="PyDiffGame logo" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/logo.png" width="420"/>
 </p>
 
 <p align="center">
@@ -68,22 +68,32 @@ accounting on a common yardstick, and ready-made plotting.
 
 # Installation
 
-Install the latest release from PyPI:
+PyDiffGame is published on [PyPI](https://pypi.org/project/PyDiffGame/) and is
+managed with [**uv**](https://docs.astral.sh/uv/). Add it to your project:
 
 ```bash
-pip install PyDiffGame
+uv add PyDiffGame
 ```
 
 To run the bundled examples (which additionally need
 [`python-control`](https://python-control.readthedocs.io/)):
 
 ```bash
-pip install "PyDiffGame[examples]"
+uv add "PyDiffGame[examples]"
 ```
 
-To work on the package itself, this project is managed with
-[**uv**](https://docs.astral.sh/uv/). Clone it and sync the locked development
-environment:
+<details>
+<summary><b>Prefer pip?</b> It works as a fallback.</summary>
+
+```bash
+pip install PyDiffGame
+pip install "PyDiffGame[examples]"   # with the examples extra
+```
+
+</details>
+
+To work on the package itself, clone it and sync the locked development
+environment with uv:
 
 ```bash
 git clone https://github.com/krichelj/PyDiffGame.git
@@ -92,7 +102,10 @@ uv sync --extra dev          # creates .venv with the exact locked dependencies
 uv run pre-commit install    # enable the formatting / lint / type-check hooks
 ```
 
-Then run anything through `uv run` (`uv run pytest`, `uv run python -m PyDiffGame.examples.MassesWithSpringsComparison`, …).
+Then run anything through `uv run` (`uv run pytest`,
+`uv run python -m PyDiffGame.examples.MassesWithSpringsComparison`, …). Pip users
+can instead `pip install -e ".[dev]"`, though uv is recommended for the exact
+locked environment.
 
 # Quick start
 
@@ -183,7 +196,7 @@ To show the package in action we compare a differential game against an LQR on a
 masses connected by springs — a textbook coupled, oscillatory system:
 
 <p align="center">
-    <img alt="Two masses connected by springs between two walls" src="images/readme/masses_schematic.png" width="760"/>
+    <img alt="Two masses connected by springs between two walls" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/readme/masses_schematic.png" width="760"/>
 </p>
 
 The physical input space is decomposed along the **modal** directions of $M^{-1}K$, so each
@@ -245,19 +258,19 @@ monolithic optimum **to numerical precision**: the two state trajectories coinci
 (they differ by ~10⁻⁷) and the costs are equal:
 
 <p align="center">
-    <img alt="State trajectories: the decomposed game reproduces the monolithic LQR" src="images/readme/masses_game_vs_lqr.png" width="860"/>
+    <img alt="State trajectories: the decomposed game reproduces the monolithic LQR" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/readme/masses_game_vs_lqr.png" width="860"/>
 </p>
 
 <p align="center">
-    <img alt="Cost comparison: the modal game recovers the LQR optimum" src="images/readme/masses_cost.png" width="440"/>
+    <img alt="Cost comparison: the modal game recovers the LQR optimum" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/readme/masses_cost.png" width="440"/>
 </p>
 
 For this modally-decoupled system the decomposition is **lossless** — and it buys
 **compositionality**: you can add, drop or re-weight a control task by editing a single
 player, without re-tuning one monolithic cost matrix.
 
 > The figures above are regenerated from the live solver by
-> [`tools/generate_readme_figures.py`](tools/generate_readme_figures.py)
+> [`tools/generate_readme_figures.py`](https://github.com/krichelj/PyDiffGame/blob/master/tools/generate_readme_figures.py)
 > (`uv run python tools/generate_readme_figures.py`), so they always match the current code.
 
 # More examples
@@ -288,7 +301,7 @@ uv run mypy        src/PyDiffGame            # type-check
 ```
 
 Continuous integration runs the formatter check, linter, type checker and full suite on
-Python 3.11–3.14. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+Python 3.11–3.14. See [CONTRIBUTING.md](https://github.com/krichelj/PyDiffGame/blob/master/CONTRIBUTING.md) for details.
 
 # Citing
 
@@ -304,7 +317,7 @@ If you use this work, please cite our paper:
     doi={10.1109/MED51440.2021.9480269}}
 ```
 
-Further details can be found in the [citation document](CITATIONS.bib).
+Further details can be found in the [citation document](https://github.com/krichelj/PyDiffGame/blob/master/CITATIONS.bib).
 
 # Acknowledgments
 
@@ -316,7 +329,7 @@ and Bar-Ilan Universities, Israel.
 
 <p align="center">
 <a href="https://istrc.net.technion.ac.il/">
-<img src="images/Logo_ISTRC_Green_English.png" height="80" alt="ISTRC"/>
+<img src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/Logo_ISTRC_Green_English.png" height="80" alt="ISTRC"/>
 </a>
 &emsp;
 <a href="https://in.bgu.ac.il/en/Pages/default.aspx">