Migrate to uv (#38)

febus982 · web-flow · commit b5be8a4abce1 · 2025-06-21T14:13:52.000+01:00
* Update pyproject.toml for uv

* Integrate tox with uv

* Update Makefile commands

* Update remaining references to poetry

* Add workaround to calculate package version for docs

* Remove `make update-dependencies`

* trigger CI
diff --git a/.github/workflows/python-code-style.yml b/.github/workflows/python-code-style.yml
@@ -21,11 +21,11 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.13"
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install poetry tox
-        make poetry-export
+        make dev-dependencies
     - name: Check code style with black
       run: |
         make format
diff --git a/.github/workflows/python-lint.yml b/.github/workflows/python-lint.yml
@@ -21,10 +21,10 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.13"
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install poetry tox
-        make poetry-export
+        make dev-dependencies
     - name: Lint with ruff
       run: make lint
diff --git a/.github/workflows/python-quality.yml b/.github/workflows/python-quality.yml
@@ -21,12 +21,11 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.13"
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install poetry
-        poetry config virtualenvs.create false
-        poetry install --no-root --with dev
+        make dev-dependencies
     - name: Test & publish code coverage
       uses: paambaati/codeclimate-action@v9.0.0
       env:
diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
@@ -28,12 +28,11 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "${{ matrix.version }}"
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install poetry
-        poetry config virtualenvs.create false
-        poetry install --no-root --with dev
+        make dev-dependencies
     - name: Test with pytest
       id: citest
       run: |
@@ -68,7 +67,7 @@ jobs:
               --body "$BODY")
             if [[ $PINNED == true ]]; then
               gh issue pin "$new_issue_url"
-            fi          
+            fi
           fi
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/python-typing.yml b/.github/workflows/python-typing.yml
@@ -21,10 +21,10 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.13"
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install poetry tox
-        make poetry-export
+        make dev-dependencies
     - name: Check typing
       run: make typing
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -22,14 +22,15 @@ jobs:
         with:
           python-version: "3.13"
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install poetry poetry-dynamic-versioning
+          make dev-dependencies
 
       - name: Build package
         run: |
-          poetry build
+          uv build
 
       - name: Archive the dist folder
         uses: actions/upload-artifact@v4
diff --git a/.github/workflows/reusable-github-pages.yml b/.github/workflows/reusable-github-pages.yml
@@ -46,12 +46,11 @@ jobs:
 
       # Here we want to install the current package in editable mode,
       # in case mkdocs needs the package (i.e. we are building a mkdocs plugin).
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install poetry
-          poetry config virtualenvs.create false
-          poetry install --with dev
+          make dev-dependencies
 
       - name: Configure Git user
         run: |
@@ -64,12 +63,12 @@ jobs:
 
       - name: Build and deploy static pages
         run: |
-          mike deploy ${{ inputs.site-version }} ${{ inputs.version-alias }} --update-aliases --push --branch ${{ inputs.branch }}
+          uv run mike deploy ${{ inputs.site-version }} ${{ inputs.version-alias }} --update-aliases --push --branch ${{ inputs.branch }}
 
       - name: Set default site version
         if: ${{ inputs.set-default }}
         run: |
-          mike set-default ${{ inputs.site-version }} --push --branch ${{ inputs.branch }}
+          uv run mike set-default ${{ inputs.site-version }} --push --branch ${{ inputs.branch }}
 
       #  `mike` is specifically built to be used together with GitHub pages.
       # To upload the website to another service (i.e. AWS S3) uncomment
diff --git a/.gitignore b/.gitignore
@@ -282,4 +282,5 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
-poetry.lock
+uv.lock
+version.py
diff --git a/.idea/bootstrap-python-package.iml b/.idea/bootstrap-python-package.iml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,8 +8,9 @@ Please note that this project is released with a Contributor Code of Conduct. By
 
 ## Submitting a pull request
 
+Before running any commands, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/):
+
 0. Fork and clone the repository
-0. Install poetry: `pip install -g poetry`
 0. Configure and install the dependencies: `make dev-dependencies`
 0. Make sure the tests pass on your machine: `make check`
 0. Create a new branch: `git checkout -b my-branch-name`
diff --git a/Makefile b/Makefile
@@ -1,49 +1,41 @@
-.PHONY: dev-dependencies update-dependencies test docs fix check typing lint format ci-test ci-coverage poetry-export
+.PHONY: dev-dependencies update-dependencies test docs fix check typing lint format ci-test ci-coverage
 
 #########################
 ###### dev commands #####
 #########################
 dev-dependencies:
-	poetry install --with dev --no-root
-
-update-dependencies:
-	poetry update --with dev
+	uv lock --upgrade
+	uv sync --all-groups --frozen
 
 test:
-	poetry run pytest -n auto --cov
+	uv run pytest -n auto --cov
 
 docs:
-	poetry run mkdocs serve
+	uv run mkdocs serve
 
 fix:
-	poetry run ruff check . --fix
-	poetry run ruff format .
-
-check: poetry-export
-	tox
-
-typing: poetry-export
-	tox -e typing
+	uv run ruff format .
+	uv run ruff check . --fix
+	uv run ruff format .
 
-lint: poetry-export
-	tox -e lint
+check:
+	uv run tox
 
-format: poetry-export
-	tox -e format
+typing:
+	uv run tox -e typing
 
+lint:
+	uv run tox -e lint
 
-#########################
-#### Helper commands ####
-#########################
-poetry-export:
-	poetry export -f requirements.txt --output /tmp/requirements.txt --with dev
+format:
+	uv run tox -e format
 
 
 #########################
 ###### CI commands ######
 #########################
 ci-test:
-	poetry run pytest
+	uv run pytest
 
 ci-coverage:
-	poetry run pytest --cov --cov-report lcov
+	uv run pytest --cov --cov-report lcov
diff --git a/README.md b/README.md
@@ -43,12 +43,12 @@ It is configured with all the following features:
 * Update the PyCharm Copyright profile in the IDE settings: Editor | Copyright | Copyright Profiles (if you want to use it)
 * Setup local development:
     * Clone the repository
-    * Install poetry `pip install poetry`
+    * [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
     * Install dev dependencies with `make dev-dependencies`
     * (optional) It is strongly recommended to install [pre-commit](https://pre-commit.com/#installation)
       and run `pre-commit install` so that formatting and linting are automatically executed during `git commit`.
 * Setup GitHub pages (this need local development setup):
-    * Initialise documentation branch `poetry run mike deploy dev latest --update-aliases --push`
+    * Initialise documentation branch `uv run mike deploy dev latest --update-aliases --push`
     * Configure GitHub Pages to deploy from the `gh-pages` branch (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages`)
     * Add the `main` branch and the `v*.*.*` tag rules to the "deployment branches and tags" list in the `gh-pages` environment (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments`)
 
@@ -59,7 +59,7 @@ and remove the marked lines in `workflows/release.yml`.
 
 ## Package release
 
-This setup uses [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning).
+This setup uses [uv-dynamic-versioning](https://github.com/ninoseki/uv-dynamic-versioning/tree/main).
 This means it's not necessary to commit the version in the code but the CI pipeline
 will infer it from the git tag.
 
@@ -72,14 +72,13 @@ To release a new version, just create a new release and tag in the GitHub reposi
 the convention `vX.X.X` (semantic versioning preceded by lowercase `v`). It will publish
 the correct version on Pypi, omitting the `v` (ie. `v1.0.0` will publish `1.0.0`).
 
-This format can be customized, refer to [poetry-dynamic-versioning docs](https://github.com/mtkennerly/poetry-dynamic-versioning)
+This format can be customized, refer to [uv-dynamic-versioning docs](https://github.com/ninoseki/uv-dynamic-versioning/tree/main).
 
 ## Commands for development
 
 All the common commands used during development can be run using make targets:
 
 * `make dev-dependencies`: Install dev requirements
-* `make update-dependencies`: Update dev requirements
 * `make fix`: Run code style and lint automatic fixes (where possible)
 * `make test`: Run test suite against system python version
 * `make check`: Run tests against all available python versions, code style and lint checks
diff --git a/bootstrap_python_package/__init__.py b/bootstrap_python_package/__init__.py
@@ -1,5 +1,5 @@
 # ==============================================================================
-#  Copyright (c) 2024 Federico Busetti                                         =
+#  Copyright (c) 2025 Federico Busetti                                         =
 #  <729029+febus982@users.noreply.github.com>                                  =
 #                                                                              =
 #  Permission is hereby granted, free of charge, to any person obtaining a     =
@@ -21,9 +21,6 @@
 #  DEALINGS IN THE SOFTWARE.                                                   =
 # ==============================================================================
 
-__version__ = "0.0.0"
-__version_tuple__ = (0, 0, 0)
-
 
 def some_function() -> str:
     """
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/scripts/docs-version.sh b/scripts/docs-version.sh
diff --git a/scripts/version_from_git.py b/scripts/version_from_git.py
diff --git a/tox.ini b/tox.ini
