Standardised infra

Author: patrick-kidger

.github/workflows/release.yml

@@ -10,14 +10,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release
-        uses: patrick-kidger/action_update_python_project@v6
+        uses: patrick-kidger/action_update_python_project@v8
         with:
             python-version: "3.11"
             test-script: |
                 cp -r ${{ github.workspace }}/test ./test
                 cp ${{ github.workspace }}/pyproject.toml ./pyproject.toml
-                python -m pip install -r ./test/requirements.txt
-                python -m test
+                uv sync --extra tests --no-install-project --inexact
+                uv run --no-sync pytest
             pypi-token: ${{ secrets.pypi_token }}
             github-user: patrick-kidger
             github-token: ${{ github.token }}

.github/workflows/run_tests.yml

@@ -23,13 +23,16 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r ./test/requirements.txt
-
+          python -m pip install '.[dev,docs,tests]'
 
       - name: Checks with pre-commit
-        uses: pre-commit/action@v3.0.1
+        run: |
+          pre-commit run --all-files
 
       - name: Test with pytest
         run: |
-          python -m pip install .
-          python -m test
+          pytest
+
+      - name: Check that documentation can be built.
+        run: |
+          mkdocs build

.gitignore

@@ -8,3 +8,4 @@ site/
 .pymon
 .idea/
 .venv/
+uv.lock

.pre-commit-config.yaml

@@ -8,15 +8,15 @@ repos:
         files: ^pyproject\.toml$
         additional_dependencies: ["toml-sort==0.23.1"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.2.2
+    rev: v0.13.0
     hooks:
       - id: ruff-format  # formatter
-        types_or: [ python, pyi, jupyter ]
+        types_or: [ python, pyi, jupyter, toml ]
       - id: ruff  # linter
-        types_or: [ python, pyi, jupyter ]
+        types_or: [ python, pyi, jupyter, toml ]
         args: [ --fix ]
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.350
+    rev: v1.1.405
     hooks:
     - id: pyright
       additional_dependencies: [equinox, jax, jaxtyping, optax, optimistix, lineax, pytest, typeguard==2.13.3, typing_extensions, wadler_lindig]

CONTRIBUTING.md

@@ -8,23 +8,15 @@ Contributions (pull requests) are very welcome! Here's how to get started.
 
 First fork the library on GitHub.
 
-Then clone and install the library in development mode:
+Then clone and install the library:
 
 ```bash
 git clone https://github.com/your-username-here/diffrax.git
 cd diffrax
-pip install -e .
+pip install -e '.[dev]'
+pre-commit install  # `pre-commit` is installed by `pip` on the previous line
 ```
 
-Then install the pre-commit hook:
-
-```bash
-pip install pre-commit
-pre-commit install
-```
-
-These hooks use ruff to lint and format the code, and pyright to type-check it.
-
 ---
 
 **If you're making changes to the code:**
@@ -34,8 +26,8 @@ Now make your changes. Make sure to include additional tests if necessary.
 Next verify the tests all pass:
 
 ```bash
-pip install -r test/requirements.txt
-pytest
+pip install -e '.[tests]'
+pytest  # `pytest` is installed by `pip` on the previous line.
 ```
 
 Then push your changes back to your fork of the repository:

pyproject.toml

@@ -25,13 +25,15 @@ keywords = ["jax", "dynamical-systems", "differential-equations", "deep-learning
 license = {file = "LICENSE"}
 name = "diffrax"
 readme = "README.md"
-requires-python = ">=3.10,<4.0"
+requires-python = ">=3.10"
 urls = {repository = "https://github.com/patrick-kidger/diffrax"}
 version = "0.7.0"
 
 [project.optional-dependencies]
+dev = ["pre-commit"]
 docs = [
   "hippogriffe==0.2.2",
+  "griffe==1.7.3",
   "mkdocs==1.6.1",
   "mkdocs-include-exclude-files==0.1.0",
   "mkdocs-ipynb==0.1.1",
@@ -40,6 +42,14 @@ docs = [
   "mkdocstrings-python==1.16.8",
   "pymdown-extensions==10.14.3"
 ]
+tests = [
+  "beartype",
+  "jaxlib",
+  "optax",
+  "pytest",
+  "scipy",
+  "tqdm",
+]
 
 [tool.hatch.build]
 include = ["diffrax/*"]
@@ -64,6 +74,11 @@ ignore = ["E402", "E721", "E731", "E741", "F722", "UP038"]
 ignore-init-module-imports = true
 select = ["E", "F", "I001", "UP"]
 
+[tool.ruff.lint.flake8-import-conventions.extend-aliases]
+"collections" = "co"
+"functools" = "ft"
+"itertools" = "it"
+
 [tool.ruff.lint.isort]
 combine-as-imports = true
 extra-standard-library = ["typing_extensions"]