build: migrate to uv (#284)

* build: migrate to uv

* build: restore phirc optional deps

* ci: disable docs build on windows

.github/workflows/python-app.yml

@@ -23,23 +23,22 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
       with:
         python-version: ${{ matrix.python-version }}
-        cache: 'pip'
+        enable-cache: true
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install -r requirements.txt
-        python -m pip install -e .
+        uv sync --all-extras --dev
     - name: Pre-commit checks
       run: |
-        pre-commit run --all-files
+        uv run pre-commit run --all-files
     - name: Run tests
       run: |
-        python -m pytest
+        uv run pytest
     - name: Sphinx documentation build
+      if: ${{ matrix.os != 'windows-latest' }}
       run: |
         make docs
     - name: Deploy to GitHub Pages

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
       - id: debug-statements
 
   - repo: https://github.com/crate-ci/typos
-    rev: typos-v0.10.34
+    rev: typos-dict-v0.12.4
     hooks:
       - id: typos
 

Makefile

@@ -1,27 +1,27 @@
 .PHONY: install dev dev-all tests lint docs clean build
 
 install:
-	pip install .
+	uv pip install .
 
 dev:
-	pip install -e .
+	uv pip install -e .
 
 dev-all:
-	pip install -e .[phirc]
+	uv pip install -e .[phirc]
 
 tests:
-	python tests/e2e_test.py
-	pytest -s -x -vv tests/test*.py
+	uv run python tests/e2e_test.py
+	uv run pytest -s -x -vv tests/test*.py
 
 lint:
-	pre-commit run --all-files
+	uv run pre-commit run --all-files
 
 docs:
-	# sphinx-apidoc --implicit-namespaces -f -o docs/source/ pytket
-	sphinx-build -M html docs/source/ docs/build/
+	# uv run sphinx-apidoc --implicit-namespaces -f -o docs/source/ pytket
+	uv run sphinx-build -M html docs/source/ docs/build/
 
 clean:
 	rm -rf *.egg-info dist build docs/build
 
 build: clean
-	python -m build --sdist --wheel -n
+	uv build

README.md

@@ -48,21 +48,12 @@ options:
 Clone the repository and run:
 
 ```sh
-python -m venv .venv
-source .venv/bin/activate
-pip install -U pip setuptools
-pip install -r requirements.txt
-pre-commit install
-```
-
-Then, install the project using:
-
-```sh
-pip install -e .
+uv sync
+uv run pre-commit install
 ```
 
 See `Makefile` for other useful commands.
 
 ## Testing
 
-Issue `pytest` from the root directory.
+Issue `make tests` from the root directory.

pyproject.toml

@@ -30,12 +30,16 @@ dependencies = [
   "phir>=0.3.3",
   "pytket>=1.34.0,<2",
   "wasmtime>=19.0.0",
-  ]
+]
 
-[project.optional-dependencies]
-docs = ["sphinx", "pydata_sphinx_theme"]
-phirc = ["projectq", "quantum-pecos>=0.6.0.dev2"]
-tests = ["pytest"]
+[dependency-groups]
+dev = [
+  "networkx<3",
+  "pre-commit==4.1.0",
+  "pydata-sphinx-theme>=0.16.1",
+  "pytest==8.3.4",
+  "sphinx>=8.1.3",
+]
 
 [project.scripts]
 phirc = "pytket.phir.cli:main"
@@ -45,6 +49,9 @@ Changelog = "https://github.com/CQCL/pytket-phir/blob/main/CHANGELOG.md"
 Documentation = "https://cqcl.github.io/pytket-phir/"
 Repository = "https://github.com/CQCL/pytket-phir.git"
 
+[project.optional-dependencies]
+phirc = ["projectq>=0.8.0", "quantum-pecos>=0.6.0.dev2"]
+
 [tool.setuptools.packages.find]
 where = ["."]