Use dependency groups, uv, and local pre-commit hooks

Author: Patrick Kidger Bot

.github/workflows/build_docs.yml

@@ -16,19 +16,18 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install '.[docs]'
+          uv run echo done
 
       - name: Build docs
         run: |
-          mkdocs build
+          uv run mkdocs build
 
       - name: Upload docs
         uses: actions/upload-artifact@v4

.github/workflows/release.yml

@@ -13,10 +13,12 @@ jobs:
         uses: patrick-kidger/action_update_python_project@v8
         with:
             python-version: "3.11"
+            # Uninstall and reinstall pytest to work around the fact that it doesn't get put into `bin` otherwise.
             test-script: |
                 cp -r ${{ github.workspace }}/tests ./tests
                 cp ${{ github.workspace }}/pyproject.toml ./pyproject.toml
-                uv sync --extra tests --no-install-project --inexact
+                uv pip uninstall pytest
+                uv sync --no-install-project --inexact
                 uv run --no-sync pytest
             pypi-token: ${{ secrets.pypi_token }}
             github-user: patrick-kidger

.github/workflows/run_tests.yml

@@ -15,24 +15,23 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install '.[dev,docs,tests]'
+          uv run echo done
 
       - name: Checks with pre-commit
         run: |
-          pre-commit run --all-files
+          uv run prek run --all-files
 
       - name: Test with pytest
         run: |
-          pytest
+          uv run pytest
 
       - name: Check that documentation can be built.
         run: |
-          mkdocs build
+          uv run mkdocs build

.pre-commit-config.yaml

@@ -1,23 +1,38 @@
+fail_fast: true
 repos:
+  - repo: meta
+    hooks:
+    - id: check-hooks-apply
+    - id: check-useless-excludes
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    - id: trailing-whitespace
+      exclude: \.md$
+    - id: check-toml
+    - id: mixed-line-ending
   - repo: local
     hooks:
-      - id: sort_pyproject
-        name: sort_pyproject
-        entry: toml-sort -i --sort-table-keys --sort-inline-tables
-        language: python
+      - id: sort-pyproject
+        name: sort pyproject
         files: ^pyproject\.toml$
-        additional_dependencies: ["toml-sort==0.23.1"]
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.13.0
-    hooks:
-      - id: ruff-format # formatter
+        language: system
+        entry: uv run -- toml-sort -i --sort-table-keys --sort-inline-tables
+      - id: ruff-format
+        name: ruff format
         types_or: [python, pyi, jupyter, toml]
-      - id: ruff # linter
+        language: system
+        entry: uv run -- ruff format --
+        require_serial: true
+      - id: ruff-lint
+        name: ruff lint
         types_or: [python, pyi, jupyter, toml]
-        args: [--fix]
-  - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.405
-    hooks:
+        language: system
+        entry: uv run -- ruff check --fix --
+        require_serial: true
       - id: pyright
-        additional_dependencies:
-          [pytest]
+        name: pyright
+        types_or: [python]
+        language: system
+        entry: uv run -- pyright
+        require_serial: true

CONTRIBUTING.md

@@ -4,30 +4,24 @@ Contributions (pull requests) are very welcome! Here's how to get started.
 
 ---
 
-**Getting started**
+### Getting started
 
-First fork the library on GitHub.
-
-Then clone and install the library:
+[We assume that you have `uv` installed.](https://docs.astral.sh/uv/) Now fork the library on GitHub. Then clone and install the library:
 
 ```bash
 git clone https://github.com/your-username-here/tinyio.git
 cd tinyio
-pip install -e '.[dev]'
-pre-commit install  # `pre-commit` is installed by `pip` on the previous line
+uv run prek install  # Creates a local venv + installs dependencies + installs pre-commit hooks.
 ```
 
 ---
 
-**If you're making changes to the code:**
-
-Now make your changes. Make sure to include additional tests if necessary.
+### If you're making changes to the code
 
-Next verify the tests all pass:
+Now make your changes. Make sure to include additional tests if necessary. Next verify the tests all pass:
 
 ```bash
-pip install -e '.[tests]'
-pytest  # `pytest` is installed by `pip` on the previous line.
+uv run pytest
 ```
 
 Then push your changes back to your fork of the repository:
@@ -40,14 +34,12 @@ Finally, open a pull request on GitHub!
 
 ---
 
-**If you're making changes to the documentation:**
+### If you're making changes to the documentation
 
 Make your changes. You can then build the documentation by doing
 
 ```bash
-pip install -e '.[docs]'
-mkdocs serve
+uv run mkdocs serve
 ```
 
 You can then see your local copy of the documentation by navigating to `localhost:8000` in a web browser.
-

docs/_static/mathjax.js

@@ -11,6 +11,6 @@ window.MathJax = {
   }
 };
 
-document$.subscribe(() => { 
+document$.subscribe(() => {
   MathJax.typesetPromise()
 })

mkdocs.yml

@@ -42,7 +42,7 @@ edit_uri: ""
 
 strict: true  # Don't allow warnings during the build process
 
-extra_javascript: 
+extra_javascript:
     # The below two make MathJax work, see https://squidfunk.github.io/mkdocs-material/reference/mathjax/
     - _static/mathjax.js
     - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

pyproject.toml

@@ -2,6 +2,26 @@
 build-backend = "hatchling.build"
 requires = ["hatchling"]
 
+[dependency-groups]
+dev = [
+  "prek==0.3.9",
+  "pyright==1.1.405",
+  "ruff==0.13.0",
+  "toml-sort==0.23.1"
+]
+docs = [
+  "hippogriffe==0.2.2",
+  "griffe==1.7.3",
+  "mkdocs==1.6.1",
+  "mkdocs-include-exclude-files==0.1.0",
+  "mkdocs-material==9.6.7",
+  "mkdocstrings==0.28.3",
+  "mkdocstrings-python==1.16.8",
+  "pygments==2.20.0",
+  "pymdown-extensions==10.21.2"
+]
+tests = ["pytest", "trio"]
+
 [project]
 authors = [
   {email = "contact@kidger.site", name = "Patrick Kidger"}
@@ -22,21 +42,6 @@ requires-python = ">=3.11"
 urls = {repository = "https://github.com/patrick-kidger/tinyio"}
 version = "0.4.0"
 
-[project.optional-dependencies]
-dev = ["prek"]
-docs = [
-  "hippogriffe==0.2.2",
-  "griffe==1.7.3",
-  "mkdocs==1.6.1",
-  "mkdocs-include-exclude-files==0.1.0",
-  "mkdocs-material==9.6.7",
-  "mkdocstrings==0.28.3",
-  "mkdocstrings-python==1.16.8",
-  "pygments==2.20.0",
-  "pymdown-extensions==10.21.2"
-]
-tests = ["pytest", "trio"]
-
 [tool.hatch.build]
 include = ["tinyio/*"]
 reportFunctionMemberAccess = false
@@ -66,3 +71,6 @@ combine-as-imports = true
 extra-standard-library = ["typing_extensions"]
 lines-after-imports = 2
 order-by-type = true
+
+[tool.uv]
+default-groups = ["dev", "docs", "tests"]