develop -> main July 2026

.dockerignore

@@ -4,6 +4,7 @@
 !tests/**/*
 !pyproject.toml
 !pdm.lock
+!uv.lock
 !README.md
 !docker-entrypoint.sh
 __pycache__

.github/workflows/ci.yml

@@ -20,56 +20,54 @@ jobs:
     name: Ruff linting, formating, MyPy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4
+      - uses: actions/checkout@v6
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: "3.10"
-          cache: true
+          python-version: "3.12"
       - name: Install dependencies
         run: |
-          pdm venv create --with-pip --force $PYTHON
-          pdm sync --dev -G:all
-      # TODO add mypy check here
-      - run: |
-          pdm run ruff format --check
-          pdm run ruff check
+          uv sync --locked --all-extras --all-groups
+      - name: Run linters and type checks
+        run: |
+          uv run ruff format --check
+          uv run ruff check
 
   test-all:
     name: Unit tests on various OSes and Python versions
     strategy:
       matrix:
         python-version:
           - python-version: "3.10"
-            continue-on-error: false
+            continue-on-error: true
           - python-version: "3.11"
-            continue-on-error: false
+            continue-on-error: true
           - python-version: "3.12"
-            continue-on-error: false
+            continue-on-error: true
           # TODO - fix issue with Jaxlib not installing
           - python-version: "3.13"
             continue-on-error: true
+          - python-version: "3.14"
+            continue-on-error: true
         os:
           - os: macos-latest
-            continue-on-error: false
+            continue-on-error: true
           - os: windows-latest
-            continue-on-error: false
+            continue-on-error: true
           - os: ubuntu-latest
-            continue-on-error: false
+            continue-on-error: true
     runs-on: ${{ matrix.os.os }}
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4
+      - uses: actions/checkout@v6
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: ${{ matrix.python-version.python-version }}
-          cache: true
+          python-version: "3.12"
       - name: Install dependencies
         run: |
-          pdm venv create --with-pip --force $PYTHON
-          pdm sync --dev -G:all
+          uv sync --locked --all-extras --all-groups
         continue-on-error: ${{ matrix.os.continue-on-error || matrix.python-version.continue-on-error }}
-      - run: pdm run test-all
+      - run: pytest tests/ --cov=src/ --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml
         continue-on-error: ${{ matrix.os.continue-on-error || matrix.python-version.continue-on-error }}
 
   docker-test:
@@ -78,9 +76,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Build Docker image
-        run: docker build -t dial:test --target test .
+        run: docker build -t dial:test --target builder --build-arg UV_NO_DEV=0 .
       - name: Run tests in container
-        run: docker run --rm dial:test pytest tests/
+        run: docker run --rm -v $PWD/tests:/app/tests/ dial:test uv run pytest tests/
+        continue-on-error: true
 
   continuous-deployment:
     name: Update deployments automatically

.github/workflows/docker-release.yml

@@ -6,7 +6,7 @@ on:
       - develop
       - main
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
   workflow_dispatch:
 
 permissions:
@@ -20,16 +20,19 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v3
+      - name: Log into registry ghcr.io
+        uses: docker/login-action@v4
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
       - name: Extract metadata (tags, labels) for Docker
         id: meta
         uses: docker/metadata-action@v5
@@ -47,11 +50,9 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
-          build-args: |
-            PRODUCTION=1
           push: true
+          platforms: linux/amd64,linux/arm64
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
-          target: runtime

.gitignore

@@ -4,6 +4,8 @@
 ### application-specific ###
 # ignore generated plots by default
 *.png
+# but don't ignore any PNG files used on the documentation website
+!/docs/**/*.png
 
 # ignore all configuration files except for our default one
 *.json
@@ -12,6 +14,8 @@
 
 # testing reports
 reports/
+# any generated custom HTML files
+*.html
 
 ### Python ###
 # Byte-compiled / optimized / DLL files
@@ -101,7 +105,7 @@ ipython_config.py
 # pyenv
 #   For a library or package, you might want to ignore these files since the code is
 #   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -206,3 +210,8 @@ pyrightconfig.json
 .ionide
 
 # End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
+
+.venv*
+Taskfile.yml
+.DS_Store
+*~

.pre-commit-config.yaml

@@ -13,13 +13,11 @@ repos:
       - id: ruff
         args: [ --fix ]
       - id: ruff-format
-  - repo: https://github.com/pdm-project/pdm
-    rev: 2.17.2
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.10.6
     hooks:
-      - id: pdm-export
-        args: ['--without-hashes']
-      - id: pdm-lock-check
-      - id: pdm-sync
+      - id: uv-lock
+      #- id: uv-export
   # TODO - enable mypy
   #- repo: local
     #hooks:

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "latest"
+
+sphinx:
+  configuration: docs/conf.py
+  # Fail on all warnings to avoid broken references
+  fail_on_warning: true
+
+formats: all
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

Dockerfile

@@ -1,44 +1,51 @@
-ARG REPO=
-# common environment variables
-FROM ${REPO}python:3.12-slim AS environment
-
-# set to non-empty string to skip dev dependencies
-ARG PRODUCTION=
-ENV PDM_VERSION=2.21.0 \
-  PDM_HOME=/usr/local \
-  PDM_CHECK_UPDATE=false \
-  PIP_NO_CACHE_DIR=off \
-  PIP_DISABLE_PIP_VERSION_CHECK=on \
-  PRODUCTION=${PRODUCTION:-}
-
-# intermediate PDM build stage
-FROM environment AS builder
+# see https://docs.astral.sh/uv/guides/integration/docker/#optimizations and https://www.joshkasuboski.com/posts/distroless-python-uv/
+
+FROM --platform=$BUILDPLATFORM ghcr.io/astral-sh/uv:debian-slim AS builder
+
+ARG PYTHON_VERSION=3.12
+# set to "0" to include dev dependencies, "1" to exclude them (default: "1")
+ARG UV_NO_DEV="1"
+
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+ENV UV_PYTHON_INSTALL_DIR=/python
+ENV UV_PYTHON_PREFERENCE=only-managed
+ENV UV_NO_DEV=${UV_NO_DEV}
+
+# TODO - remove git once we install Sable from PyPI
+RUN apt update -y
+RUN apt install -y --no-install-recommends \
+    git \
+    ca-certificates \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN uv python install ${PYTHON_VERSION}
 
 WORKDIR /app
-RUN apt update \
-  && apt-get install --no-install-recommends -y \
-    curl \
-    make \
-  && rm -rf /var/lib/apt/lists/* \
-  && curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python -
-
-# add minimal files needed for package install
-COPY pyproject.toml README.md pdm.lock ./
+
+# Install (required) dependencies
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project --no-editable
+
+# Sync the project
 COPY src src
-RUN if [ -n "${PRODUCTION}" ]; then pdm sync --no-editable --prod; else pdm sync --no-editable --dev; fi
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    --mount=type=bind,source=README.md,target=README.md \
+    uv sync --locked --no-editable
 
-# main execution environment
-FROM environment AS runtime
+FROM --platform=$BUILDPLATFORM gcr.io/distroless/cc:nonroot AS runner
+
+COPY --from=builder --chown=app:app /python /python
 
 WORKDIR /app
+COPY --from=builder --chown=app:app /app/.venv /app/.venv
+COPY --chown=app:app scripts scripts
 
-COPY --from=builder /app/.venv /app/.venv
-COPY scripts scripts
 ENV PATH="/app/.venv/bin:$PATH"
 
 # override CMD at container runtime if you want to execute the client, make sure that "client" group is present
 CMD ["python", "scripts/launch_service.py"]
-
-# add additional files for testing
-FROM runtime AS test
-COPY tests tests

README.md

@@ -22,13 +22,16 @@ Alternatively, both intersect-sdk and Dial may be installed with the following:
 
 ## Installing (developers)
 
-Install PDM ([link](https://pdm-project.org/en/latest/#installation)) and then run:
+Install UV ([link](https://docs.astral.sh/uv/getting-started/installation/)) and then run:
 
-`pdm install`
+```
+uv sync --all-groups --all-extras --all-packages
+pre-commit install
+```
 
-We use PDM as a dependency manager and intend on using the dependencies listed in `pdm.lock` in a production environment.
+We use UV as a dependency manager and intend on using the dependencies listed in `uv.lock` in a production environment.
 
-We use ruff to lint/format; if using the PDM workflow, `pre-commit` will automatically fail the commit if there are linting/formatting errors.
+We use ruff to lint/format; if using the UV workflow, `pre-commit` will automatically fail the commit if there are linting/formatting errors.
 
 To format:
 
@@ -40,9 +43,9 @@ To run linter and automatically fix errors:
 
 ## running infrastructure locally
 
-You can use `docker compose up -d -f docker-compose-dev.yml` or to automatically spin up both a broker instance and a database instance locally.
+You can use `docker compose -f docker-compose-dev.yml up` or to automatically spin up both a broker instance and a database instance locally.
 
-If you also want to run DIAL inside the container, you can instead run `docker compose up -d`
+If you also want to run DIAL inside the container, you can instead run `docker compose up`
 
 To remove the infrastructure containers: `docker compose down -v`; leave off the `-v` flag if you would like to persist the DB data.
 
@@ -51,8 +54,9 @@ To remove the infrastructure containers: `docker compose down -v`; leave off the
 To run the service: `python scripts/launch_service.py`
 
 In a separate terminal, you can run one of the following clients:
-  - Automatic: `python scripts/automated_client.py`
-  - Manual: `python scripts/manual_client.py`
+
+- Automatic: `python scripts/automated_client.py`
+- Manual: `python scripts/manual_client.py`
 
 CLI arg `--config` or environment variable `DIAL_CONFIG_FILE` should be a path to a valid JSON configuration. If neither value is set, it will default to `local-conf.json` .
 
@@ -90,21 +94,25 @@ helm install dial . -n dial --create-namespace
 ```
 
 For detailed Helm chart documentation, see:
+
 - [charts/dial/README.md](charts/dial/README.md) - Comprehensive Helm documentation
 
 ### Common Helm Commands
 
 With custom INTERSECT configuration:
+
 ```bash
 helm install dial . -n dial --create-namespace -f values.yaml -f values.config.yaml
 ```
 
 With NodePort service:
+
 ```bash
 helm install dial . -n dial --create-namespace -f values.yaml -f values.nodePort.yaml
 ```
 
 With external MongoDB:
+
 ```bash
 helm install dial . -n dial --create-namespace \
   --set mongodb.enabled=false \
@@ -113,6 +121,12 @@ helm install dial . -n dial --create-namespace \
 
 ## Testing
 
-You will need `pytest` installed to run the tests, it should be automatically included in your virtual environment if using the PDM workflow.
+You will need `pytest` installed to run the tests.
+
+`pytest tests/`
+
+## Building the documentation
+
+You will need to make sure the `docs` optional dependency group is installed. Then you can run `sphinx build -W --keep-going docs/ docs/_build/` .
 
-`pdm run test-all`
+To quickly spin up the documentation web server on `http://localhost:8000` : `python -m http.server -d docs/_build/`