Converted to use uv and hatch over venv and tox

Author: OCopping

.devcontainer/devcontainer.json

@@ -8,6 +8,8 @@
     "remoteEnv": {
         // Allow X11 apps to run inside the container
         "DISPLAY": "${localEnv:DISPLAY}"
+        // Add venv to path for cmd line tools to be recognised by default, e.g. hatch
+        "PATH": "${containerWorkspaceFolder}/.venv/bin:${containerEnv:PATH}"
     },
     "customizations": {
         "vscode": {
@@ -41,6 +43,6 @@
     ],
     // 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": "pip install $([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e '.[dev]' && pre-commit install"
+    // After the container is created, install the uv env
+    "postCreateCommand": "bash .devcontainer/post-install.sh"
 }

.github/actions/install_requirements/action.yml

@@ -4,9 +4,6 @@ inputs:
   python-version:
     description: Python version to install, default is from Dockerfile
     default: "dev"
-  pip-install:
-    description: Parameters to pass to pip install
-    default: "$([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e .[dev]"
 
 runs:
   using: composite
@@ -20,15 +17,25 @@ runs:
         echo "PYTHON_VERSION=$PYTHON_VERSION" >> "$GITHUB_ENV"
       shell: bash
 
-    - name: Setup python
-      uses: actions/setup-python@v5
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v5
       with:
         python-version: ${{ env.PYTHON_VERSION }}
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
 
-    - name: Install packages
-      run: pip install ${{ inputs.pip-install }}
+    - name: Install dependencies
+      run: uv sync --dev
       shell: bash
 
     - name: Report what was installed
-      run: pip freeze
+      run: uv pip list
+      shell: bash
+
+    - name: Add venv path to Github environment
+      run: echo "VENV_PATH=.venv" >> $GITHUB_ENV
+      shell: bash
+
+    - name: Add venv path to Github Path
+      run: echo "${{ env.VENV_PATH }}/bin:$PATH" >> $GITHUB_PATH
       shell: bash

.github/workflows/_hatch.yml

@@ -0,0 +1,27 @@
+on:
+  workflow_call:
+    inputs:
+      hatch:
+        type: string
+        description: What to run under hatch
+        required: true
+
+
+jobs:
+  run:
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install python packages
+        uses: ./.github/actions/install_requirements
+
+      - name: Run hatch
+        run: |
+          IFS=',' read -ra SCRIPTS <<< "${{ inputs.hatch }}"
+          for script in "${SCRIPTS[@]}"; do
+            echo "Running $script"
+            hatch run $script
+          done

.github/workflows/_release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Create GitHub Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@7b4da11513bf3f43f9999e90eabced41ab8bb048 # v2.2.0
+        uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

.github/workflows/_test.yml

@@ -51,7 +51,7 @@ jobs:
           pip-install: ".[dev]"
 
       - name: Run tests
-        run: tox -e tests
+        run: hatch run tests
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5

.github/workflows/ci.yml

@@ -11,37 +11,45 @@ jobs:
   lint:
     needs: check
     if: needs.check.outputs.branch-pr == ''
-    uses: ./.github/workflows/_tox.yml
+    uses: ./.github/workflows/_hatch.yml
     with:
-      tox: pre-commit
+      hatch: precommit,type-check
 
   test:
     needs: check
     if: needs.check.outputs.branch-pr == ''
+    strategy:
+      matrix:
+        runs-on: ["ubuntu-latest"] # can add windows-latest, macos-latest
+        python-version: ["3.11"]
+        include:
+          # Include one that runs in the dev environment
+          - runs-on: "ubuntu-latest"
+            python-version: "dev"
+      fail-fast: false
     uses: ./.github/workflows/_test.yml
     with:
-      python-version: dev
-      runs-on: ubuntu-latest
+      runs-on: ${{ matrix.runs-on }}
+      python-version: ${{ matrix.python-version }}
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-  docs:
+  container:
     needs: check
     if: needs.check.outputs.branch-pr == ''
-    uses: ./.github/workflows/_docs.yml
+    uses: ./.github/workflows/_container.yml
     permissions:
-      contents: write
+      contents: read
+      packages: write
 
-  example:
-    needs: test
-    if: github.ref_name == 'main'
-    uses: ./.github/workflows/_example.yml
-    secrets:
-      EXAMPLE_DEPLOY_KEY: ${{ secrets.EXAMPLE_DEPLOY_KEY }}
+  dist:
+    needs: check
+    if: needs.check.outputs.branch-pr == ''
+    uses: ./.github/workflows/_dist.yml
 
   release:
     if: github.ref_type == 'tag'
-    needs: docs
+    needs: [dist]
     uses: ./.github/workflows/_release.yml
     permissions:
       contents: write

Dockerfile

@@ -4,10 +4,28 @@ ARG PYTHON_VERSION=3.11
 FROM python:${PYTHON_VERSION} AS developer
 
 # Add any system dependencies for the developer/build environment here
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    graphviz \
-    && rm -rf /var/lib/apt/lists/*
+RUN apt-get update && apt upgrade -y && rm -rf /var/lib/apt/lists/*
+# Install uv using the official installer script
+RUN curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# The build stage installs the context into the venv
+FROM developer AS build
+# install uv
+RUN pip install -U uv
+# disable update check
+ENV UV_CHECK_UPDATE=false
+# copy files
+# * means it will only try to copy uv.lock if it exists already
+COPY pyproject.toml uv.lock* README.md LICENSE /project/
+COPY src/ /project/src
+
+# install dependencies and project into the local packages directory
+WORKDIR /project
+RUN uv sync --dev --no-editable
+
+# The runtime stage copies the built venv into a slim runtime container
+FROM python:${PYTHON_VERSION}-slim AS runtime
+# Add apt-get system dependecies for runtime here if needed
+COPY --from=build /project/.venv/ /project/.venv
+ENV PATH="/project/.venv/bin:$PATH"
 
-# Set up a virtual environment and put it in PATH
-RUN python -m venv /venv
-ENV PATH=/venv/bin:$PATH

post-install.sh

@@ -0,0 +1,3 @@
+pip install --upgrade pip
+uv python install
+uv sync --dev

pyproject.toml

@@ -9,19 +9,22 @@ requires-python = ">=3.10"
 
 [project.optional-dependencies]
 dev = [
+    "basedpyright>=1.27.1",
     "copier",
+    "hatch>=1.14.0",
     "myst-parser",
     "pre-commit",
     "pydata-sphinx-theme>=0.12",
-    "pytest",
+    "pytest>=8.3.4",
     "ruff",
     "sphinx-autobuild",
     "sphinx-copybutton",
     "sphinx-design",
-    "tox",
-    "tox-direct",
 ]
 
+[tool.uv]
+default-groups = []
+
 [tool.setuptools_scm]
 
 [tool.pytest.ini_options]
@@ -32,27 +35,33 @@ addopts = """
 # Doctest python code in docs, python code in src docstrings, test functions in tests
 testpaths = "tests"
 
-# tox must currently be configured via an embedded ini string
-# See: https://github.com/tox-dev/tox/issues/999
-[tool.tox]
-legacy_tox_ini = """
-[tox]
-skipsdist=True
+[tool.hatch.envs.default.scripts]
+all = [
+    "hatch run precommit:precommit",
+    "hatch run type-check:type-check",
+    "hatch run tests:tests",
+    "hatch run docs:docs"
+]
+precommit = ["hatch run precommit:precommit"]
+type-check = ["hatch run type-check:type-check"]
+tests = ["hatch run tests:tests"]
+docs = ["hatch run docs:docs"]
+
+[tool.hatch.envs.precommit]
+description = "Run pre-commit"
+scripts = { precommit = ["pre-commit run  --show-diff-on-failure {args}"] }
+
+[tool.hatch.envs.type-check]
+description = "Run type-checking"
+scripts = { type-check = ["basedpyright --stats src {args}"] }
+
+[tool.hatch.envs.tests]
+description = "Run tests"
+scripts = { tests = ["pytest {args}"] }
 
-[testenv:{pre-commit,tests,docs}]
-# Don't create a virtualenv for the command, requires tox-direct plugin
-direct = True
-passenv = *
-allowlist_externals =
-    pre-commit
-    pytest
-    sphinx-build
-    sphinx-autobuild
-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.hatch.envs.docs]
+description = "Run docs"
+scripts = { docs = ["sphinx-{args:build} -EW --keep-going -T docs build/html"] }
 
 [tool.ruff]
 src = ["src", "tests"]