Embed code snippets for README from executable examples

.github/workflows/shared.yml

@@ -3,6 +3,9 @@ name: Shared Checks
 on:
   workflow_call:
 
+permissions:
+  contents: read
+
 jobs:
   pre-commit:
     runs-on: ubuntu-latest
@@ -46,3 +49,19 @@ jobs:
       - name: Run pytest
         run: uv run --frozen --no-sync pytest
     continue-on-error: true
+
+  readme-snippets:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: 0.7.2
+
+      - name: Install dependencies
+        run: uv sync --frozen --all-extras --python 3.10
+
+      - name: Check README snippets are up to date
+        run: uv run --frozen scripts/update_readme_snippets.py --check

.pre-commit-config.yaml

@@ -23,6 +23,7 @@ repos:
         types: [python]
         language: system
         pass_filenames: false
+        exclude: ^README\.md$
       - id: pyright
         name: pyright
         entry: uv run pyright
@@ -36,3 +37,9 @@ repos:
         language: system
         files: ^(pyproject\.toml|uv\.lock)$
         pass_filenames: false
+      - id: readme-snippets
+        name: Check README snippets are up to date
+        entry: uv run scripts/update_readme_snippets.py --check
+        language: system
+        files: ^(README\.md|examples/.*\.py|scripts/update_readme_snippets\.py)$
+        pass_filenames: false

CONTRIBUTING.md

@@ -40,7 +40,12 @@ uv run ruff check .
 uv run ruff format .
 ```
 
-7. Submit a pull request to the same branch you branched from
+7. Update README snippets if you modified example code:
+```bash
+uv run scripts/update_readme_snippets.py
+```
+
+8. Submit a pull request to the same branch you branched from
 
 ## Code Style