#32 - switch from PDM to UV

Signed-off-by: Lance-Drane <Lance-Drane@users.noreply.github.com>

Author: Lance-Drane

.dockerignore

@@ -1,12 +1,16 @@
-.venv
-dist
-build
-.pdm-python
-.pdm-build
-.mypy_cache
-.pytest_cache
-.ruff_cache
-report_unit.xml
-coverage.xml
-htmlcov/
-reports/
+# ignore everything by default
+*
+# but do not ignore core files
+!src/
+!docs/
+!examples/
+!tests/
+!pyproject.toml
+!uv.lock
+# README is used in pyproject.toml
+!README.md
+# but make sure to ignore cache
+__pycache__/
+*.pyc
+# and also ignore the doc website build
+docs/_build/

.github/workflows/ci.yml

@@ -20,20 +20,19 @@ 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.12"
-          cache: true
       - name: Install dependencies
         run: |
-          pdm venv create --with-pip --force $PYTHON
-          pdm sync --dev -G:all
-      - run: |
-          pdm run ruff format --check
-          pdm run ruff check
-          pdm run lint-mypy
+          uv sync --locked --all-extras --all-groups
+      - name: Run linters and type checks
+        run: |
+          uv run ruff format --check
+          uv run ruff check
+          uv run mypy src/intersect_sdk/
 
   # Run unit tests only on Windows/MacOS, we can run the full test suite on Linux
   test-unit:
@@ -47,16 +46,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
-          cache: true
       - name: Install dependencies
         run: |
-          pdm venv create --with-pip --force $PYTHON
-          pdm sync --dev -G:all
-      - run: pdm run test-unit
+          uv sync --locked --all-extras --all-groups
+      - name: Run tests
+        run: uv run pytest tests/unit/ --cov=src/intersect_sdk/ --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml
 
   # we can only run our full test suite on Ubuntu due to the Github Actions services requirement
   test-complete:
@@ -91,13 +89,12 @@ jobs:
           - "9001:9001" # web UI
     steps:
       - uses: actions/checkout@v4
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
-          cache: true
       - name: Install dependencies
         run: |
-          pdm venv create --with-pip --force $PYTHON
-          pdm sync --dev -G:all
-      - run: pdm run test-all
+          uv sync --locked --all-extras --all-groups
+      - name: Run tests
+        run: uv run pytest tests/ --cov=src/intersect_sdk/ --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml

.github/workflows/publish.yml

@@ -2,28 +2,30 @@ name: Release to PyPi
 
 on:
   push:
-    tags: "v[0-9]+.[0-9]+.[0-9]+*"
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
   workflow_dispatch:
 
-permissions:
-  contents: write
-  id-token: write
-
 jobs:
   build:
     if: startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/intersect-sdk
     steps:
       - uses: actions/checkout@v4
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: "3.8"
-          cache: true
+          python-version: "3.12"
+      - name: "Build package"
+        run: uv build --no-create-gitignore
       - name: Publish package to PyPI
-        env:
-          PDM_PUBLISH_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-        run: pdm publish --username __token__ --repository pypi
+        run: uv publish
       - name: upload to github release
         uses: docker://antonyurchenko/git-release:v5
         env:

.gitignore

@@ -370,7 +370,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.

.pre-commit-config.yaml

@@ -13,19 +13,17 @@ 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
   - repo: local
     hooks:
       - id: mypy
         name: MyPy
         description: use MyPy for static type checking
-        entry: pdm run lint-mypy
+        entry: uv run mypy src/intersect_sdk/
         pass_filenames: false
         language: system
   - repo: https://github.com/codespell-project/codespell

DEVELOPING.md

@@ -8,15 +8,18 @@ Documentation for the INTERSECT Python SDK can be viewed at https://intersect-py
 
 ## Quickstart (developers)
 
-This project uses [PDM](https://pdm.fming.dev/latest/) for Python tooling. Install PDM and run `pdm install -G:all`, or `pdm update` if resyncing the repository.
+This project uses UV for Python tooling. For initial setup:
 
-To install pre-commit hooks, run `pdm run pre-commit install` after installation.
-
-Main commands are specified under `tool.pdm.scripts` in `pyproject.toml`
+```bash
+uv venv .venv
+source .venv/bin/activate
+uv sync --all-extras --all-groups
+uv run pre-commit install
+```
 
 ### Docker build instructions
 
-`docker build --target minimal -t intersect-sdk-python .`
+`docker build -t intersect-sdk-python .`
 
 You will only need to rebuild this image if you need to add/update dependencies.
 
@@ -28,25 +31,28 @@ If you don't want to use this docker-compose file, note that running a full Serv
 
 ## Adding dependencies
 
-- **Required dependency**: `pdm add <dependency>`
-- **Optional dependency**: `pdm add -G <group> <dependency>`
-- **Dev dependency** `pdm add --dev -G <dev-group> <dependency>`
+- **Required dependency**: `uv add <dependency>`
+- **Optional dependency**: `uv add <dependency> --optional`
+- **Dev dependency** `uv add --dev <dependency>`
+
+Regarding development dependencies:
 
-For dev dependencies, please always specify the dev group as one of `lint`, `test`, or `doc`.
+- install documentation dependencies with `uv add <dependency> --optional docs`
 
 ## Linting
 
-Run `pdm run lint` to quickly run all linters. The pre-commit hooks will also catch this.
+- Formatting: `uv run ruff format`
+- Linting: `uv run ruff check --fix`
+- Type analysis: `uv run mypy src/`
 
-## Testing
+The pre-commit hooks will also lint for you.
 
-Note that for the integration and e2e tests, you will need to spin up the docker-compose instance.
+## Testing
 
-`pdm run test-all` - run all tests in standard format.
-`pdm run test-all-debug` - run tests allowing debug output (i.e. print statements in tests)
-`pdm run test-unit` - run only the unit tests (no backing services required for these)
+If you are running the integration tests or the e2e tests, you will need to spin up the docker-compose instance.
 
-Tests are run with pytest if you'd like to customize how they are run. The full `pdm run test...` scripts can be found in `pyproject.toml`
+`uv run pytest tests/` - run all tests in standard format.
+`uv run pytest tests/unit/` - run only the unit tests (no backing services required for these)
 
 ## Examples
 

Dockerfile

@@ -1,32 +1,23 @@
-# container for CI/CD or development - NOT meant to be an extensible Docker image with the installed package
+# Development Dockerfile. Installs all development dependencies, runs as root (so the environment is mutable), intends for you to mount the directory as a volume if you're developing inside of it.
+#
+FROM ghcr.io/astral-sh/uv:python3.12-trixie-slim
 
-ARG REPO=
+WORKDIR /app
 
-# use this stage for development
-FROM ${REPO}python:3.8-slim as minimal
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+ENV UV_TOOL_BIN_DIR=/usr/local/bin
 
-ENV PYTHONUNBUFFERED=1 \
-    PYTHONDONTWRITEBYTECODE=1 \
-    PIP_NO_CACHE_DIR=off \
-    PIP_DISABLE_PIP_VERSION_CHECK=on \
-    PIP_DEFAULT_TIMEOUT=100 \
-    PDM_VERSION=2.17.3 \
-    PDM_HOME=/usr/local
-# uncomment to allow prereleases to be installed
-#ENV PDM_PRERELEASE=1
-ENV PATH="/root/.local/bin:$PATH"
+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 --no-install-project --all-groups --all-extras
 
-RUN apt update \
-    && apt install -y curl make \
-    && rm -rf /var/lib/apt/lists/* \
-    && curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python -
+COPY . /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --all-groups --all-extras
 
-WORKDIR /sdk
-# add minimal files needed for build
-COPY pyproject.toml pdm.lock README.md ./
-COPY src/intersect_sdk/version.py src/intersect_sdk/version.py
-RUN pdm sync --dev -G:all
+ENV PATH="/app/.venv/bin:$PATH"
 
-# use this stage in CI/CD, not useful in development
-FROM minimal as complete
-COPY . .
+ENTRYPOINT ["uv", "run"]
+CMD ["/bin/bash"]

docs/Dockerfile

@@ -6,7 +6,7 @@ Read the sections below if you would like to contribute to the development of th
 Installing for package development
 ----------------------------------
 
-Follow the steps discussed in this section to install the intersect-sdk package in a Python development environment. First, install Python and PDM on your local machine. See the :doc:`installation` page for more details. Next, clone the sdk repository as follows:
+Follow the steps discussed in this section to install the intersect-sdk package in a Python development environment. First, install Python and UV on your local machine. See the :doc:`installation` page for more details. Next, clone the sdk repository as follows:
 
 .. code-block:: bash
 
@@ -17,27 +17,27 @@ Create a Python virtual environment in the root level of the repository and acti
 .. code-block:: bash
 
    # Create a virtual environment and activate it
-   cd sdk
-   python -m venv venv
-   source venv/bin/activate
+   cd python-sdk
+   uv venv .venv
+   source .venv/bin/activate
 
-Use PDM to install the intersect-sdk package and its dependencies into the virtual environment.
+Use UV to install the intersect-sdk package and its dependencies into the virtual environment.
 
 .. code-block:: bash
 
-   # Install the intersect-sdk package into the virtual environment using PDM
-   pdm install
+   # Install the intersect-sdk package into the virtual environment using UV
+   uv sync --all-extras --all-groups
 
 Check the installation by running one of the examples, such as the :doc:`examples/hello-world` example. Use the command shown below to deactivate the virtual environment:
 
 .. code-block:: bash
 
    deactivate
 
-PDM
+UV
 ------
 
-The `PDM <https://pdm.fming.dev/latest/>`_ packaging and dependency management tool is used to install the intersect-sdk package in editable (developer) mode. It is also used to run linter checks, formatter checks, and unit tests. Download and install PDM using the instructions on the PDM website.
+The `UV <https://docs.astral.sh/uv//>`_ packaging and dependency management tool is used to install the intersect-sdk package in editable (developer) mode. It is also used to run linter checks, formatter checks, and unit tests. Download and install UV using the instructions on the UV website.
 
 Documentation
 -------------