tox-uv tweaks

Author: coretl

.devcontainer/devcontainer.json

@@ -19,17 +19,7 @@
             "settings": {
                 "python.defaultInterpreterPath": "/workspaces/${localWorkspaceFolderBasename}/.venv/bin/python",
                 "python.terminal.activateEnvInCurrentTerminal": false,
-                "python.terminal.activateEnvironment": false,
-                "python.testing.unittestEnabled": false,
-                "python.testing.pytestEnabled": true,
-                "editor.formatOnSave": true,
-                "editor.codeActionsOnSave": {
-                    "source.organizeImports": "explicit"
-                },
-                "remote.autoForwardPorts": false,
-                "[python]": {
-                    "editor.defaultFormatter": "charliermarsh.ruff"
-                }
+                "python.terminal.activateEnvironment": false
             },
             // Add the IDs of extensions you want installed when the container is created.
             "extensions": [
@@ -73,5 +63,5 @@
     // Mount the parent as /workspaces so we can pip install peers as editable
     "workspaceMount": "source=${localWorkspaceFolder}/..,target=/workspaces,type=bind",
     // After the container is created, install the python project in editable form
-    "postCreateCommand": "uv sync && uv run pre-commit install"
+    "postCreateCommand": "uv sync && uv run pre-commit install --install-hooks"
 }

.github/actions/install_requirements/action.yml

@@ -12,11 +12,6 @@ jobs:
           # Need this to get version number from last tag
           fetch-depth: 0
 
-      - name: Build sdist and wheel
-        run: >
-          export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) &&
-          pipx run build
-
       - name: Install uv
         uses: astral-sh/setup-uv@v6
 

.github/workflows/_dist.yml

@@ -3,8 +3,8 @@ on:
     inputs:
       python-version:
         type: string
-        description: The version of python to install
-        required: true
+        description: The version of python to install, default is from .python-version file
+        default: ""
       runs-on:
         type: string
         description: The runner to run this job on

.github/workflows/_test.yml

@@ -18,7 +18,6 @@ jobs:
     uses: ./.github/workflows/_test.yml
     with:
       runs-on: ubuntu-latest
-      python-version: ""
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 

.github/workflows/ci.yml

@@ -10,4 +10,4 @@ jobs:
   linkcheck:
     uses: ./.github/workflows/_tox.yml
     with:
-      tox: docs build -- -b linkcheck
+      tox: docs -- build -b linkcheck

.github/workflows/periodic.yml

@@ -26,10 +26,10 @@ repos:
         types: [python]
         require_serial: true
 
-      # Make sure lock file is up to date.
+      # Make sure lock file satisfies dependencies in pyproject.toml.
       - id: uv-lock
         name: update uv.lock
         pass_filenames: false
         language: system
         entry: uv lock
-        files: ^(uv\.lock|pyproject\.toml|uv\.toml)$
+        files: ^(uv\.lock|pyproject\.toml)$

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
 # The developer stage is used as a devcontainer including dev versions
 # of the build dependencies
 FROM ghcr.io/diamondlightsource/ubuntu-devcontainer:noble AS developer
+
+# Add any system dependencies for the developer/build environment here
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    graphviz

Dockerfile

@@ -23,7 +23,7 @@ $ firefox build/html/index.html
 You can also run an autobuild process, which will watch your `docs` directory for changes and rebuild whenever it sees changes, reloading any browsers watching the pages:
 
 ```
-$ tox -e docs autobuild
+$ tox -e docs -- autobuild
 ```
 
 You can view the pages at localhost:
@@ -35,5 +35,5 @@ $ firefox http://localhost:8000
 If you are making changes to source code too, you can tell it to watch changes in this directory too:
 
 ```
-$ tox -e docs autobuild -- --watch src
+$ tox -e docs -- autobuild --watch src
 ```

docs/how-to/build-docs.md

@@ -18,8 +18,7 @@ dev = [
     "sphinx-autobuild",
     "sphinx-copybutton",
     "sphinx-design",
-    "tox-direct",
-    "twine>=6.1.0",
+    "tox-uv",
 ]
 
 [tool.setuptools_scm]
@@ -32,51 +31,21 @@ addopts = """
 # Doctest python code in docs, python code in src docstrings, test functions in tests
 testpaths = "tests"
 
-
+# tox must be configured via an embedded ini string to support
+# using positional args as parts of command arguments
 [tool.tox]
-skipsdist = true
-requires = ["tox-uv>=1.25.0"]
-# envs to runs automatically with tox -p
-env_list = ["pre-commit", "tests", "docs"]
-
-[tool.tox.env]
-passenv = { "*" = "" }
-# Include setuptools, pip, ... in the tox envs
-uv_seed = { enabled = true }
-
-[tool.tox.env.pre-commit]
-description = "Run pre-commit"
-allowlist_externals = ["pre-commit"]
-commands = [
-    [
-        "pre-commit",
-        "run",
-        #"--all-files",
-        "--show-diff-on-failure",
-        { replace = "posargs", default = [], extend = true },
-    ],
-]
-
-[tool.tox.env.tests]
-description = "Run tests"
-allowlist_externals = ["pytest"]
-commands = [["pytest", { replace = "posargs", default = [], extend = true }]]
+legacy_tox_ini = """
+[tox]
+skipsdist=True
+env_list = pre-commit,tests,docs
 
-[tool.tox.env.docs]
-description = "Run docs"
-allowlist_externals = ["sphinx-build", "sphinx-autobuild"]
-commands = [
-    [
-        "sphinx-build",
-        "-T",
-        "docs",
-        "build/html",
-        { replace = "posargs", default = [
-            "-EW",
-            "--keep-going",
-        ], extend = true },
-    ],
-]
+[testenv:{pre-commit,tests,docs}]
+passenv = *
+commands =
+    pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
+    tests: pytest {posargs}
+    docs: sphinx-{posargs:build -EW --keep-going} -T docs build/html
+"""
 
 [tool.ruff]
 src = ["src", "tests"]