Update copier template

Author: znichollscr

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v0.11.0
+_commit: v0.12.3
 _src_path: gl:openscm/copier-core-python-repository
 conda_release: false
 email: [email protected]

.github/workflows/ci.yaml

@@ -182,7 +182,7 @@ jobs:
         run: |
           pip install --upgrade pip wheel
           pip install .
-          pip install -r requirements-only-tests-locked.txt
+          pip install -r requirements-only-tests-min-locked.txt
       - name: Run tests
         run: |
           pytest tests -r a -vv tests
@@ -198,12 +198,17 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@v4
-      - uses: ./.github/actions/setup
+      - name: Set up Python "${{ matrix.python-version }}"
+        id: setup-python
+        uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
-          uv-dependency-install-flags: "--no-dev"  # no extras is default
+          python-version: "${{ matrix.python-version }}"
+      - name: Install
+        run: |
+          pip install --upgrade pip wheel
+          pip install .
       - name: Check importable without extras
-        run: uv run python scripts/test-install.py
+        run: python scripts/test-install.py
 
   check-build:
     strategy:
@@ -220,6 +225,15 @@ jobs:
         with:
           version: "0.5.21"
           python-version: ${{ matrix.python-version }}
+      - name: Setup PDM
+        uses: pdm-project/[email protected]
+        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
       - name: Build package
         run: |
           uv build

.github/workflows/deploy.yaml

@@ -34,6 +34,15 @@ jobs:
         with:
           version: "0.5.21"
           python-version: ${{ matrix.python-version }}
+      - name: Setup PDM
+        uses: pdm-project/[email protected]
+        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
       - name: Publish to PyPI
         run: |
           uv build

.github/workflows/release.yaml

@@ -27,6 +27,15 @@ jobs:
         with:
           version: "0.5.21"
           python-version: ${{ matrix.python-version }}
+      - name: Setup PDM
+        uses: pdm-project/[email protected]
+        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
       - name: Add version to environment
         run: |
           PROJECT_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ ci:
   autoupdate_schedule: quarterly
   autoupdate_branch: pre-commit-autoupdate
   # Currently network access isn't supported in the pre-commit CI product.
-  skip: [uv-sync, uv-lock, uv-export, pdm-lock-check]
+  skip: [uv-sync, uv-lock, uv-export]
 
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
@@ -60,19 +60,3 @@ repos:
         args: ["-o", "requirements-only-tests-locked.txt", "--no-hashes", "--no-dev", "--no-emit-project", "--only-group", "tests"]
       # # Not released yet
       # - id: uv-sync
-  - repo: https://github.com/pdm-project/pdm
-    rev: 2.22.1
-    hooks:
-      # Update the `pdm.lock` file if needed.
-      # We need the pdm lock file too
-      # so that we can build the locked version of the package.
-      - name: pdm-lock
-        id: pdm-lock-check
-        # Overwrite the hook's standard entry point to get the behaviour we want
-        entry: pdm lock
-        args: ["--group", ":all", "--strategy", "inherit_metadata"]
-        files: ^pyproject.toml$
-        pass_filenames: false
-      # Double check that the `pdm.lock` file is up to date.
-      - id: pdm-lock-check
-        args: ["--group", ":all", "--strategy", "inherit_metadata"]

Makefile

@@ -38,7 +38,7 @@ ruff-fixes:  ## fix the code using ruff
 
 .PHONY: test
 test:  ## run the tests
-	uv run pytest src tests -r a -v --doctest-modules --cov=src
+	uv run pytest src tests -r a -v --doctest-modules --doctest-report ndiff --cov=src
 
 # Note on code coverage and testing:
 # You must specify cov=src.
@@ -77,11 +77,6 @@ licence-check:  ## Check that licences of the dependencies are suitable
 	uv run liccheck -r $(TEMP_FILE) -R licence-check.txt
 	rm -f $(TEMP_FILE)
 
-.PHONY: pdm-lock
-pdm-lock: pdm.lock  ## create/update the `pdm.lock` file
-
-pdm.lock: pyproject.toml
-	pdm lock --group :all --strategy inherit_metadata
 
 .PHONY: virtual-environment
 virtual-environment:  ## update virtual environment, create a new one if it doesn't already exist

docs/NAVIGATION.md

@@ -10,6 +10,7 @@ See https://oprypin.github.io/mkdocs-literate-nav/
     - [Run code in a notebook](how-to-guides/run-code-in-a-notebook.py)
 - [Tutorials](tutorials/index.md)
 - [Further background](further-background/index.md)
+    - [Dependency pinning and testing](further-background/dependency-pinning-and-testing.md)
 - [Development](development.md)
 - [API reference](api/gcages/)
 - [Changelog](changelog.md)

docs/development.md

@@ -74,6 +74,7 @@ The steps required are the following:
    else
 
 1. Enjoy the newly available version
+[TODO: add in conda release instructions]
 
 #### Further details
 
@@ -82,8 +83,8 @@ while [uv figures out how it wants to support building](https://github.com/astra
 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 have a pdm pre-commit hook
-and a `pdm.lock` file in our repository.
+It is for these reasons that we create a `pdm.lock` file
+before any step related to building the package in the CI.
 
 ## Read the Docs
 

docs/further-background/dependency-pinning-and-testing.md

@@ -24,8 +24,7 @@ In the majority of cases, new releases do not cause issues
 so pinning simply forces users to workaround overly strict pins[^1]
 (which can be done, see
 [working around incorrectly set pins][working-around-incorrectly-set-pins]).
-The tradeoff with this approach is
-This does run the risk that,
+The tradeoff with this approach is that you run the risk that,
 if a dependency releases a breaking change,
 the function provided by our package may break too.
 
@@ -128,12 +127,12 @@ Finally, we also check the installation of the locked versions of the package,
 i.e. installation with `pip install 'gcages[locked]'`.
 These tests give us the greatest coverage of Python versions and operating systems
 and help alert us to places where users may face issues.
-Having said that, these tests do require 30 separate CI runs,
+Having said that, these tests do require 30 separate jobs,
 which is why we don't run them in CI.
 
 Through this combination of CI testing and installation testing,
 we get a pretty good coverage of the different ways in which our package can be used.
 It is not perfect, largely because the combinatorics don't allow for testing everything.
 If we find a particular, key, use case failing often,
 then we would happily discuss whether this should be included in the CI too,
-to catch issues earlier than at user time.
+to catch issues in advance of use.

mkdocs.yml

@@ -87,6 +87,9 @@ plugins:
             - https://docs.scipy.org/doc/scipy/objects.inv
             - https://scitools-iris.readthedocs.io/en/stable/objects.inv
             - https://scmdata.readthedocs.io/en/stable/objects.inv
+            # # Not available for tqdm
+            # # https://github.com/tqdm/tqdm/issues/705
+            # - https://tqdm.github.io/objects.inv
             - https://validators.readthedocs.io/en/stable/objects.inv
             - http://xarray.pydata.org/en/stable/objects.inv
           options:
@@ -111,6 +114,7 @@ plugins:
 markdown_extensions:
   # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
   - attr_list
+  - footnotes
   # https://squidfunk.github.io/mkdocs-material/reference/math/#katex-mkdocsyml
   - pymdownx.arithmatex:
       generic: true