Merge pull request #31 from openscm/uv-build

Switch to uv build backend

Author: znicholls

.github/actions/setup/action.yml

@@ -20,7 +20,7 @@ runs:
       id: setup-uv
       uses: astral-sh/setup-uv@v4
       with:
-        version: "0.5.21"
+        version: "0.8.8"
         python-version: ${{ inputs.python-version }}
     - name: Install dependencies
       shell: bash

.github/workflows/bump.yaml

@@ -1,25 +1,21 @@
 name: Bump version
-# For the time being, we still do this with pdm.
-# Honestly, it doesn't really matter,
-# but one day uv will have a bump command too and we can switch to that.
-# Relevant issue in uv: https://github.com/astral-sh/uv/issues/6298
 
 on:
   workflow_dispatch:
     inputs:
       bump_rule:
         type: choice
-        description: How to bump the project's version (see https://github.com/carstencodes/pdm-bump#usage)
+        description: How to bump the project's version (see https://docs.astral.sh/uv/reference/cli/#uv-version)
         options:
-          - no-pre-release
-          # no micro because we always sit on a pre-release in main,
-          # so we would always use no-pre-release instead of micro
-          # - micro
+          - stable
+          - patch
           - minor
           - major
-          - "pre-release --pre alpha"
-          - "pre-release --pre beta"
-          - "pre-release --pre release-candidate"
+          - alpha
+          - beta
+          - rc
+          - post
+          - dev
         required: true
 
 jobs:
@@ -40,15 +36,6 @@ jobs:
           fetch-depth: 0
           token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
 
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install pdm-bump
-        run: |
-          pdm self add pdm-bump
-
       - uses: ./.github/actions/setup
         with:
           python-version: ${{ matrix.python-version }}
@@ -63,7 +50,7 @@ jobs:
           echo "Bumping from version $BASE_VERSION"
 
           # Bump
-          pdm bump ${{ github.event.inputs.bump_rule }}
+          uv version --bump ${{ github.event.inputs.bump_rule }}
 
           NEW_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
           echo "Bumping to version $NEW_VERSION"
@@ -81,7 +68,7 @@ jobs:
           BASE_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
 
           # Bump to pre-release of next version
-          pdm bump pre-release --pre alpha
+          uv version --bump post
 
           NEW_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
           echo "Bumping version $BASE_VERSION > $NEW_VERSION"

.github/workflows/ci.yaml

@@ -148,7 +148,7 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
       - name: Create venv
         run: |
@@ -267,21 +267,15 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Generate pdm.lock
-        # Required for building the locked version of the package
-        # with pdm-build-locked (see pyproject.toml)
-        run: |
-          pdm lock --group :all --strategy inherit_metadata --python="<3.13"
-          pdm lock --group :all  --python=">=3.13" --append
       - name: Build package
         run: |
+          uv run python scripts/add-locked-targets-to-pyproject-toml.py
+          cat pyproject.toml
           uv build
+          # Just in case, undo the changes to `pyproject.toml`
+          git restore --staged . && git restore .
       - name: Check build
         run: |
           tar -tvf dist/pandas_openscm-*.tar.gz --wildcards '*pandas_openscm/py.typed'

.github/workflows/deploy.yaml

@@ -32,19 +32,12 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Generate pdm.lock
-        # Required for building the locked version of the package
-        # with pdm-build-locked (see pyproject.toml)
-        run: |
-          pdm lock --group :all --strategy inherit_metadata --python="<3.13"
-          pdm lock --group :all  --python=">=3.13" --append
       - name: Publish to PyPI
         run: |
+          uv run python scripts/add-locked-targets-to-pyproject-toml.py
           uv build
           uv publish
+          # Just in case, undo the changes to `pyproject.toml`
+          git restore --staged . && git restore .

.github/workflows/release.yaml

@@ -25,25 +25,18 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Generate pdm.lock
-        # Required for building the locked version of the package
-        # with pdm-build-locked (see pyproject.toml)
-        run: |
-          pdm lock --group :all --strategy inherit_metadata --python="<3.13"
-          pdm lock --group :all  --python=">=3.13" --append
       - name: Add version to environment
         run: |
           PROJECT_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
           echo "PROJECT_VERSION=$PROJECT_VERSION" >> $GITHUB_ENV
       - name: Build package for PyPI
         run: |
+          uv run python scripts/add-locked-targets-to-pyproject-toml.py
           uv build
+          # Just in case, undo the changes to `pyproject.toml`
+          git restore --staged . && git restore .
       - name: Generate Release Notes
         run: |
           echo "" >> ".github/release_template.md"

.github/workflows/test-upstream-latest.yaml

@@ -36,7 +36,7 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
       # Often you need a step like this for e.g. numpy, scipy, pandas
       - name: Setup compilation dependencies

changelog/31.trivial.md

@@ -0,0 +1 @@
+Switched to using uv for the build backend. Updated dev docs accordingly, including describing the purpose of `scripts/add-locked-targets-to-pyproject-toml.py`.

docs/development.md

@@ -48,16 +48,16 @@ should change depending on the updates to the code base.
 Releasing is semi-automated via a CI job.
 The CI job requires the type of version bump
 that will be performed to be manually specified.
-See the pdm-bump docs for the
-[list of available bump rules](https://github.com/carstencodes/pdm-bump#usage).
+See the `uv version` docs (specifically the `--bump` flag) for the
+[list of available bump rules](https://docs.astral.sh/uv/reference/cli/#uv-version).
 
 ### Standard process
 
 The steps required are the following:
 
 1. Bump the version: manually trigger the "bump" workflow from the main branch
    (see here: [bump workflow](https://github.com/openscm/pandas-openscm/actions/workflows/bump.yaml)).
-   A valid "bump_rule" (see [pdm-bump's docs](https://github.com/carstencodes/pdm-bump#usage))
+   A valid "bump_rule" (see [uv's docs](https://docs.astral.sh/uv/reference/cli/#uv-version))
    will need to be specified.
    This will then trigger a draft release.
 
@@ -87,12 +87,10 @@ The steps required are the following:
 
 #### Further details
 
-We use [pdm](https://pdm-project.org/en/latest/) for building our project,
-while [uv figures out how it wants to support building](https://github.com/astral-sh/uv/issues/3957).
-This gives us the added benefit that we can use
-[pdm-build-locked](https://pdm-build-locked.readthedocs.io/en/stable/)
-to build locked versions of our package.
-It is for these reasons that we create a `pdm.lock` file
+We use [uv's build backend](https://docs.astral.sh/uv/concepts/build-backend) for building our project
+and `scripts/add-locked-targets-to-pyproject-toml.py`
+to provide locked extra groups for our package.
+Including locked extra groups is why we run `scripts/add-locked-targets-to-pyproject-toml.py`
 before any step related to building the package in the CI.
 
 ## Read the Docs

pyproject.toml

@@ -90,6 +90,7 @@ dev = [
     "types-tqdm>=4.67.0.20241221",
     "tomli>=2.2.1",
     "typer>=0.15.2",
+    "tomli-w>=1.2.0",
 ]
 docs = [
     # Key dependencies
@@ -154,16 +155,11 @@ all-dev = [
 ]
 
 [build-system]
-requires = [
-    "pdm-backend",
-    "pdm-build-locked",
-]
-build-backend = "pdm.backend"
+requires = ["uv_build>=0.8.7,<0.9.0"]
+build-backend = "uv_build"
 
-[tool.pdm]
-[tool.pdm.build]
-locked = true
-includes = [
+[tool.uv.build-backend]
+source-include = [
     "src/pandas_openscm",
     "LICENCE",
 ]

scripts/add-locked-targets-to-pyproject-toml.py

@@ -0,0 +1,85 @@
+"""
+Add locked targets to `pyproject.toml`
+
+This adds a "locked" target
+plus a "<option>-locked" target
+for each optional dependency group.
+
+Only works with uv.
+"""
+
+from __future__ import annotations
+
+import copy
+import subprocess
+from pathlib import Path
+
+import tomli_w
+import tomllib
+
+
+def parse_uv_export_output(raw: str) -> list[str]:
+    """
+    Parse `uv export` output
+
+    Parameters
+    ----------
+    raw
+        Raw output string
+
+    Returns
+    -------
+    :
+        Parsed dependencies
+    """
+    raw_split = raw.splitlines()
+    deps = [v for v in raw_split if not v.strip().startswith("#")]
+
+    return deps
+
+
+def main():
+    """
+    Update the `pyproject.toml` file with locked targets
+    """
+    project_root = Path(__file__).parents[1]
+    pyproject_file = project_root / "pyproject.toml"
+    pyproject_file_out = pyproject_file
+    # Handy for testing
+    # pyproject_file_out = project_root / "pyproject.toml.injected"
+
+    with open(pyproject_file, "rb") as fh:
+        pyproject_in = tomllib.load(fh)
+
+    pyproject_out = copy.deepcopy(pyproject_in)
+    for optional_dep, uv_export_flags in (
+        ("locked", ()),
+        *(
+            (f"{extra}-locked", ("--extra", extra))
+            for extra in pyproject_in["project"]["optional-dependencies"]
+        ),
+    ):
+        uv_export_res = subprocess.run(  # noqa: S603
+            (
+                "uv",
+                "export",
+                "--no-hashes",
+                "--no-annotate",
+                "--no-emit-project",
+                "--no-dev",
+                *uv_export_flags,
+            ),
+            check=True,
+            stdout=subprocess.PIPE,
+        )
+
+        parsed_deps = parse_uv_export_output(uv_export_res.stdout.decode())
+
+        pyproject_out["project"]["optional-dependencies"][optional_dep] = parsed_deps
+
+    with open(pyproject_file_out, "wb") as f:
+        tomli_w.dump(pyproject_out, f)
+
+
+if __name__ == "__main__":
+    main()