Update uv by Sahil590 · Pull Request #557 · ImperialCollegeLondon/python-template

Sahil Raja (Sahil590) · 2026-05-20T13:30:34Z

Description

I have removed all the refs to poetry and pip-tools in the template and this repo.

Close #507

Type of change

Documentation (non-breaking change that adds or improves the documentation)
New feature (non-breaking change which adds functionality)
Optimization (non-breaking, back-end change that speeds up the code)
Bug fix (non-breaking change which fixes an issue)
Breaking change (whatever its nature)

Key checklist

All tests pass (eg. python -m pytest)
Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

Code is commented, particularly in hard-to-understand areas
Tests added or an issue has been opened to tackle that in the future.
(Indicate issue here: # (issue))

…d of getting from the pyproject

Copilot

Pull request overview

This pull request migrates the template repository to an uv-only packaging workflow, removing Poetry and pip-tools support and updating the cookiecutter hook + CI to match.

Changes:

Add uv project metadata and lockfile for the template repository (pyproject.toml, uv.lock).
Remove Poetry/pip-tools-specific template files, requirements files, and workflows; update documentation to reflect uv-only support.
Update the cookiecutter post-generation hook to add dependencies via uv, and replace related unit tests.

Reviewed changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`uv.lock`	Adds an uv lockfile for reproducible dependency resolution in the template repo.
`pyproject.toml`	Defines the template repo as an uv-managed (non-packaged) project with dev dependency groups.
`README.md`	Updates top-level documentation to uv-only and removes Poetry/pip-tools references.
`hooks/post_gen_project.py`	Switches post-generation dependency setup to `uv add` and simplifies packaging branching.
`tests/test_pyproject_patching.py`	Replaces prior pyproject patching tests with tests for the new `uv` hook behaviour.
`cookiecutter.json`	Fixes `packaging` to `"uv"` (no longer a multi-option choice).
`dev-requirements.txt`	Removes pip-based dev requirements file from the template repo.
`{{ cookiecutter.project_slug }}/pyproject.toml`	Removes multi-packager templating branches, leaving the uv path.
`{{ cookiecutter.project_slug }}/.github/workflows/ci.yml`	Removes Poetry/pip-tools branches and keeps uv-only CI steps.
`{{ cookiecutter.project_slug }}/.github/workflows/docs.yml`	Removes non-uv branches; docs build uses uv-only installation.
`.github/workflows/ci-uv.yml`	Updates template-repo CI to install deps via `uv sync` instead of pip requirements.
`.github/workflows/ci-poetry.yml`	Removes Poetry CI workflow.
`.github/workflows/ci-pip-tools.yml`	Removes pip-tools CI workflow.
`{{ cookiecutter.project_slug }}/README.poetry.jinja`	Removes Poetry-specific generated project README fragment.
`{{ cookiecutter.project_slug }}/README.pip-tools.jinja`	Removes pip-tools-specific generated project README fragment.
`{{ cookiecutter.project_slug }}/requirements.txt`	Removes pip-tools autogenerated requirements artefact from the template.
`{{ cookiecutter.project_slug }}/dev-requirements.txt`	Removes pip-tools autogenerated dev requirements artefact from the template.
`{{ cookiecutter.project_slug }}/doc-requirements.txt`	Removes pip-tools autogenerated doc requirements artefact from the template.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 17 out of 18 changed files in this pull request and generated 5 comments.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 17 out of 18 changed files in this pull request and generated 3 comments.

Alex Dewar (alexdewar) · 2026-05-28T08:04:02Z

+def add_uv_dependencies():
+    subprocess.run(["git", "init"], check=True)
+    subprocess.run(["uv", "add", "--dev", *DEV_DEPS], check=True)
+    if MKDOCS_ENABLED:
+        subprocess.run(["uv", "add", "--group", "doc", *DOC_DEPS], check=True)


Is the git init necessary or can we get away without it Sahil Raja (@Sahil590)? We decided against doing this previously: #17

Its needed for the setuptools-scm it fails when it cannot detect a git repo.

Ah yes, that is annoying. We have been talking about maybe getting rid of setuptools-scm for this reason (or making it configurable; #526). We were planning on talking about it at the next tech forum.

Does setuptools-scm work even if your git repo doesn't have any commits in it?

I suppose if it's going to be a requirement for users to have git on their PATH to use this template, we should probably document this.

PS - I guess if we are going to initialise git for the repo, then we could also install the pre-commit hooks while we're at it. Just a thought. Maybe better to open an issue for that one

Ah yes, that is annoying. We have been talking about maybe getting rid of setuptools-scm for this reason (or making it configurable; #526). We were planning on talking about it at the next tech forum.

Does setuptools-scm work even if your git repo doesn't have any commits in it?

I suppose if it's going to be a requirement for users to have git on their PATH to use this template, we should probably document this.

I guess then we can leave this until we discuss the setuptools-scm in the forum meeting.

Yeah, I think this is ok for now. I don't think we should wait until we've figured out the setuptools-scm thing before merging this PR though, as that should probably be done separately anyway.

Ok will address the rest of the comments then should be ready

I'd definitely rather not have git init run automatically. Which part failed because of setuptools-scm was it the uv add steps?

Diego Alonso Álvarez (dalonsoa)

This looks good to me. I've tested it and it works fine. Just a couple of minor comments.

Alex Dewar (alexdewar)

This is great. Thank you!

There are a few small tweaks needed, but it's mostly there.

Alex Dewar (alexdewar) · 2026-05-28T08:04:02Z

+def add_uv_dependencies():
+    subprocess.run(["git", "init"], check=True)
+    subprocess.run(["uv", "add", "--dev", *DEV_DEPS], check=True)
+    if MKDOCS_ENABLED:
+        subprocess.run(["uv", "add", "--group", "doc", *DOC_DEPS], check=True)


Is the git init necessary or can we get away without it Sahil Raja (@Sahil590)? We decided against doing this previously: #17

Co-authored-by: Alex Dewar <alexdewar@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 17 out of 18 changed files in this pull request and generated 4 comments.

Alex Dewar (alexdewar) · 2026-06-10T11:12:38Z

+def test_check_uv_installed_success(monkeypatch):
+    with patch("hooks.post_gen_project.subprocess.run") as mock_run:
+        post_gen_project.check_uv_installed()
+    mock_run.assert_called_once_with(["uv", "--version"], check=True, stdout=-3)


Alex Dewar (alexdewar) · 2026-06-10T11:14:00Z

+def add_uv_dependencies():
+    subprocess.run(["git", "init"], check=True)
+    subprocess.run(["uv", "add", "--dev", *DEV_DEPS], check=True)
+    if MKDOCS_ENABLED:
+        subprocess.run(["uv", "add", "--group", "doc", *DOC_DEPS], check=True)


This is one reason not to unconditionally run git init on a new repo, but admittedly not a strong one 😛

Alex Dewar (alexdewar)

I think this is there except for the failing tests. There are just a few markdownlint issues in the readme file.

Alex Dewar (alexdewar) · 2026-06-10T11:20:47Z

+
+        ```bash
+        git init
+        ```


Markdownlint is complaining about a few of these code blocks, which is why the CI is failing. Maybe it's the extra level of indentation that's causing the issue?

Testing this is currently a bit annoying: you have to generate a new project, then initialise pre-commit and run the hooks.

markdownlint-fix.........................................................Failed - hook id: markdownlint-fix - exit code: 1 - files were modified by this hook README.md:29 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] README.md:49 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] README.md:55 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] README.md:61 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] README.md:67 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] README.md:73 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]

Alex Dewar (alexdewar) · 2026-06-10T11:22:46Z

+def add_uv_dependencies():
+    subprocess.run(["git", "init"], check=True)
+    subprocess.run(["uv", "add", "--dev", *DEV_DEPS], check=True)
+    if MKDOCS_ENABLED:
+        subprocess.run(["uv", "add", "--group", "doc", *DOC_DEPS], check=True)


PS - I guess if we are going to initialise git for the repo, then we could also install the pre-commit hooks while we're at it. Just a thought. Maybe better to open an issue for that one

Sahil Raja (Sahil590) added 8 commits May 20, 2026 14:05

remove and update CI workflows for template repo

c932d0c

update readme in template and repo

3a19f93

update ci for template

c56ecf3

update cookiecutter json

77cf1b7

use uv in the template repo

2305cd9

remove the requirements files as no longer needed

067a323

remove refs to old tools and add a new hook for running uv add instea…

73b9a5c

…d of getting from the pyproject

remove the setuptools-scm versiona and initialise git instead

76ac340

Copilot AI review requested due to automatic review settings May 20, 2026 13:30

Sahil Raja (Sahil590) requested review from Adrian D'Alessandro (AdrianDAlessandro), Alex Dewar (alexdewar), Christopher Cave-Ayland (cc-a) and Diego Alonso Álvarez (dalonsoa) as code owners May 20, 2026 13:30

Copilot started reviewing on behalf of Sahil Raja (Sahil590) May 20, 2026 13:30 View session

update ci pytest to use uv

8c2c411

Copilot AI reviewed May 20, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md

Comment thread .github/workflows/ci-uv.yml Outdated

Comment thread hooks/post_gen_project.py

Comment thread tests/test_pyproject_patching.py

Sahil Raja (Sahil590) and others added 2 commits May 20, 2026 14:38

update ci pytest to use uv

e0460cc

Change test command from 'uv pytest' to 'uv run -m pytest'

5bca66a

Copilot AI review requested due to automatic review settings May 20, 2026 14:11

Copilot AI reviewed May 20, 2026

View reviewed changes

Comment thread .github/workflows/ci-uv.yml Outdated

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread hooks/post_gen_project.py

Comment thread cookiecutter.json

Copilot started reviewing on behalf of Sahil Raja (Sahil590) May 20, 2026 14:27 View session

Sahil Raja (Sahil590) and others added 2 commits May 20, 2026 15:45

fix cookiecutter ci

b74fb25

Potential fix for pull request finding

ee22dac

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings May 20, 2026 14:47

Copilot started reviewing on behalf of Sahil Raja (Sahil590) May 20, 2026 14:47 View session

Copilot AI reviewed May 20, 2026

View reviewed changes

Sahil Raja (Sahil590) added 2 commits May 20, 2026 16:00

update readme to add installtion of uv step

bd2e1ed

add check to see if uv is installed

cb6238f

Diego Alonso Álvarez (dalonsoa) reviewed May 22, 2026

View reviewed changes

Comment thread .github/workflows/ci-uv.yml Outdated

Comment thread cookiecutter.json Outdated

Alex Dewar (alexdewar) reviewed May 28, 2026

View reviewed changes

Apply suggestions from code review

0a792bc

Co-authored-by: Alex Dewar <alexdewar@users.noreply.github.com>

Copilot AI review requested due to automatic review settings May 29, 2026 08:49

Copilot started reviewing on behalf of Sahil Raja (Sahil590) May 29, 2026 08:49 View session

Copilot AI reviewed May 29, 2026

View reviewed changes

Sahil Raja (Sahil590) added 7 commits June 8, 2026 15:52

fix tests

faf0d61

remove package option in cookiecutter

c12579b

update readme instructions to use uvx

39d4b0f

mrege readme

a250542

update package option in dependabot file

837ab24

update spelling

3c64ad7

Merge branch 'main' into update-uv

7bb33c2

Sahil Raja (Sahil590) requested a review from Alex Dewar (alexdewar) June 8, 2026 15:12

Alex Dewar (alexdewar) requested changes Jun 10, 2026

View reviewed changes

Uh oh!

Conversation

Sahil Raja (Sahil590) commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Key checklist

Further checks

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Diego Alonso Álvarez (dalonsoa) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Alex Dewar (alexdewar) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Alex Dewar (alexdewar) left a comment

Sahil Raja (Sahil590) commented May 20, 2026 •

edited

Loading