chore: cleanup

Author: lewisjared

.github/workflows/ci.yaml

@@ -18,16 +18,8 @@ jobs:
         uses: astral-sh/setup-uv@v8.1.0
       - name: Sync environment
         run: uv sync --extra dev
-      - name: Ruff check (package + scripts)
-        run: uv run ruff check src tests
-      - name: Ruff check (notebooks)
-        run: uv run nbqa ruff notebooks
-      - name: Check Binder requirements are in sync
-        run: |
-          cp .binder/requirements.txt /tmp/requirements.committed.txt
-          bash scripts/export_requirements.sh
-          diff /tmp/requirements.committed.txt .binder/requirements.txt \
-            || (echo "::error::.binder/requirements.txt is stale; run scripts/export_requirements.sh" && exit 1)
+      - name: Run pre-commit hooks
+        run: uv run pre-commit run --all-files
 
   notebooks:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -8,30 +8,28 @@ The notebook set is designed to grow. To add one:
 
 1. **Pick the next number.** Notebooks use a two-digit prefix
    (`05-your-topic.ipynb`) in `notebooks/`. The number defines reading order.
-2. **Write the notebook.** Keep it focused on a single learning goal. State
-   prerequisites in the first markdown cell. Reuse the `ref_tutorials` helper
-   package rather than repeating client/plotting boilerplate — if you find
-   yourself copying code between notebooks, add a helper instead.
+2. **Write the notebook.** Keep it focused on a single learning goal.
+   State prerequisites in the first markdown cell.
+   Reuse the `ref_tutorials` helper package rather than repeating client/plotting boilerplate.
 3. **Add an index row.** Add the notebook to the table in `README.md`.
-4. **Leave outputs in.** Notebook outputs are intentionally committed so the
-   notebooks render on GitHub. Run the notebook top-to-bottom before
-   committing so the saved outputs are current.
+4. **Leave outputs in.** Notebook outputs are intentionally committed so the notebooks render on GitHub.
+   Run the notebook top-to-bottom before committing so the saved outputs are current.
 5. **Check it passes CI** (below).
 
 ## The `ref_tutorials` helper package
 
-Shared logic lives in `src/ref_tutorials`. It has a deliberately small, stable
-interface. New helpers should be pure and testable where possible — add a unit
-test in `tests/` for any non-trivial logic.
+Shared logic lives in `src/ref_tutorials`.
+It has a deliberately small, stable interface.
+New helpers should be pure and testable where possible.
+ Add a unit test in `tests/` for any non-trivial logic.
 
 ## Running checks locally
 
 ```bash
 uv sync --extra dev
 
 # Lint
-uv run ruff check src tests
-uv run nbqa ruff notebooks
+uv run ruff check .
 
 # Unit tests for the helper package
 uv run pytest tests
@@ -43,17 +41,11 @@ uv run pytest --nbmake notebooks
 
 ## Dependencies
 
-`pyproject.toml` is the source of truth, managed with `uv`. After changing
-dependencies, regenerate the Binder requirements file:
-
-```bash
-bash scripts/export_requirements.sh
-```
-
-CI fails if `.binder/requirements.txt` is out of sync.
+`pyproject.toml` is the source of truth, managed with `uv`.
+After changing dependencies,
+the pre-commit hook will update the `requirements.txt` file which is used by Binder.
 
 ## CI
 
-Every pull request runs three jobs: lint, helper-package unit tests, and full
-notebook execution. A weekly scheduled run catches drift against the live REF
-API even when the repo is idle.
+Every pull request runs three jobs: lint, helper-package unit tests, and full notebook execution.
+A weekly scheduled run catches drift against the live REF API even when the repo is idle.

pyproject.toml

@@ -35,7 +35,6 @@ dependencies = [
 dev = [
     "pytest>=8.0",
     "nbmake>=1.5",
-    "nbqa>=1.8",
     "ruff>=0.6",
     "pre-commit>=4.6",
 ]

src/ref_tutorials/plotting.py

@@ -4,8 +4,6 @@
 readers a recipe they can copy into their own work.
 """
 
-from __future__ import annotations
-
 from pathlib import Path
 
 import matplotlib.pyplot as plt

src/ref_tutorials/provider.py

@@ -14,8 +14,6 @@
 - **figures** (a timeseries plot and an anomaly plot).
 """
 
-from __future__ import annotations
-
 import importlib.metadata
 from pathlib import Path
 

tests/test_provider.py

@@ -8,8 +8,6 @@
 notebook 04 in CI; here we only check the provider is wired up correctly.
 """
 
-from __future__ import annotations
-
 import pytest
 
 pytest.importorskip("climate_ref_core")

tests/test_ref_tutorials.py

@@ -1,7 +1,5 @@
 """Unit tests for the ``ref_tutorials`` helper package."""
 
-from __future__ import annotations
-
 from dataclasses import dataclass, field
 
 import matplotlib
@@ -16,8 +14,6 @@
 )
 from ref_tutorials.plotting import PUBLICATION_RCPARAMS
 
-# The Agg backend is selected in conftest.py before this module is imported.
-
 
 @dataclass
 class _Dimensions:
@@ -30,7 +26,7 @@ class _MetricValue:
     dimensions: _Dimensions
 
     @classmethod
-    def make(cls, value: float, **dims: object) -> _MetricValue:
+    def make(cls, value: float, **dims: object) -> "_MetricValue":
         return cls(value=value, dimensions=_Dimensions(additional_properties=dict(dims)))