build: use pyproject dependency groups and uv (#366)

* update ci

* remove lockfile for now

* remove frozen

* nodev

* whoops

* add cache dep glob

* add color

* print compiled

* try qt

* refactor CI workflow: streamline environment variables and simplify install step

* add name

* nonconflict

* pin pyside2 numpy

* add early pydantic

* fix syntax

* fix syntax

* fix syntax

* rename step

* drop pyside2 pin pydantic

* fix codspeed

* fix group

* add no sync

* try activate

* use dot

* try plain python

* remove no sync

* back to py3.10

* bump to py3.13

* update benchmarks job to use actions/setup-python@v5 and set HATCH_BUILD_HOOKS_ENABLE environment variable

Author: tlambert03

.devcontainer/Dockerfile

@@ -20,63 +20,90 @@ jobs:
       - run: pipx run check-manifest
 
   test:
-    name: Test
-    uses: pyapp-kit/workflows/.github/workflows/test-pyrepo.yml@v2
-    with:
-      os: ${{ matrix.os }}
-      python-version: ${{ matrix.python-version }}
-      pip-post-installs: ${{ matrix.pydantic }}
-      hatch-build-hooks-enable: ${{ matrix.compile }}
-      pip-install-pre-release: ${{ github.event_name == 'schedule' }}
-      coverage-upload: artifact
+    name: Test ${{ matrix.qt }} ${{ matrix.os }} py${{ matrix.python-version }} mypyc-${{ matrix.compile }} ${{ matrix.pydantic }}
+    runs-on: ${{ matrix.os }}
+    env:
+      HATCH_BUILD_HOOKS_ENABLE: ${{ matrix.compile }}
+      UV_NO_SYNC: "1"
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.9", "3.11", "3.13"]
         os: [ubuntu-latest, macos-latest, windows-latest]
-        compile: [true, false]
+        compile: ["1", "0"]
+        qt: [""]
+        pydantic: [""]
         include:
+          - os: ubuntu-latest
+            python-version: "3.10"
+            compile: "1"
           - os: ubuntu-latest
             python-version: "3.12"
-            pydantic: "'pydantic<2'"
+            compile: "1"
+          # pydantic versions
+          - os: ubuntu-latest
+            python-version: "3.10"
+            pydantic: "pydantic==1.10"
+            compile: "1"
+          - os: ubuntu-latest
+            python-version: "3.9"
+            pydantic: "pydantic==1.10"
+            compile: "0"
+          # qt stuff
+          - os: macos-latest
+            python-version: "3.10"
+            qt: "PyQt5"
+            compile: "0"
           - os: windows-latest
             python-version: "3.11"
-            pydantic: "'pydantic<2'"
-        exclude:
-          # still working on ci test errors
-          - os: windows-latest
-            python-version: "3.12"
-          - compile: true
+            qt: "PySide6"
+            compile: "1"
+          - os: ubuntu-latest
             python-version: "3.13"
+            qt: "PyQt6"
+            compile: "1"
 
-  test-qt:
-    name: Test Qt
-    uses: pyapp-kit/workflows/.github/workflows/test-pyrepo.yml@v2
-    with:
-      os: ${{ matrix.os }}
-      python-version: ${{ matrix.python-version }}
-      qt: ${{ matrix.qt }}
-      extras: "test,testqt"
-      hatch-build-hooks-enable: ${{ matrix.compile }}
-      pip-install-pre-release: ${{ github.event_name == 'schedule' }}
-      coverage-upload: artifact
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.10"]
-        os: [macos-latest, windows-latest]
-        qt: [PyQt5, PyQt6, PySide6]
-        compile: [true, false]
-        include:
-          - os: macos-13
-            qt: "PySide2 'numpy<2'"
-          - os: windows-latest
-            python-version: "3.9"
-            qt: "PySide2 'numpy<2'"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+          cache-dependency-glob: "**/pyproject.toml"
+
+      - name: Install the project
+        run: |
+          uv sync --no-dev --group test
+          uv run python -c "import psygnal; print('compiled:', psygnal._compiled)"
+
+      - if: matrix.qt != ''
+        uses: pyvista/setup-headless-display-action@v4
+        with:
+          qt: true
+
+      - if: matrix.qt != ''
+        run: |
+          uv sync --no-dev --group testqt
+          uv pip install ${{ matrix.qt }}
+
+      - if: matrix.pydantic != ''
+        name: downgrade pydantic
+        run: uv pip install ${{ matrix.pydantic }}
+
+      - name: Test
+        shell: bash
+        run: uv run coverage run -p -m pytest -v
+
+      - name: Upload coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: covreport-${{ matrix.os }}-py${{ matrix.python-version }}-mypyc${{ matrix.compile }}-${{ matrix.qt }}-${{ matrix.pydantic }}
+          path: ./.coverage*
+          include-hidden-files: true
 
   upload_coverage:
     if: always()
-    needs: [test, test-qt]
+    needs: [test]
     uses: pyapp-kit/workflows/.github/workflows/upload-coverage.yml@v2
     secrets: inherit
 
@@ -109,17 +136,17 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
 
-      - name: install
+      - name: Install the project
         run: |
-          python -m pip install -e .[test]
-          python -m pip install pytest-codspeed
-          python -c "import sys, psygnal; sys.exit(0 if psygnal._compiled else 1)"
+          python -m pip install -U pip
+          python -m pip install . --group test-codspeed
+          python -c "import psygnal; print('compiled:', psygnal._compiled)"
         env:
           HATCH_BUILD_HOOKS_ENABLE: "1"
 
       - name: Run benchmarks
         uses: CodSpeedHQ/action@v3
         with:
-          run: pytest --codspeed -v --color=yes
+          run: pytest --codspeed -v

.devcontainer/add-notice.sh

@@ -113,3 +113,6 @@ _version.py
 psygnal/_version.py
 .asv/
 wheelhouse/
+
+# for now...
+uv.lock  

.devcontainer/devcontainer.json

@@ -5,15 +5,12 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.9"
+    python: "3.12"
+  jobs:
+    post_install:
+      - pip install uv
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --link-mode=copy
 
 mkdocs:
   configuration: mkdocs.yml
   fail_on_warning: true
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs

.devcontainer/noop.txt

@@ -1,7 +1,7 @@
 .PHONY: build check clean benchmark-all benchmark-compare typetest
 
 build:
-	HATCH_BUILD_HOOKS_ENABLE=1 uv pip install -e . --force-reinstall
+	HATCH_BUILD_HOOKS_ENABLE=1 uv sync --force-reinstall
 
 check:
 	pre-commit run --all-files

.github/workflows/test.yml

@@ -121,16 +121,22 @@ https://codspeed.io/pyapp-kit/psygnal
 
 ## Developers
 
+### Setup
+
+This project uses PEP 735 dependency groups.
+
+After cloning, setup your env with `uv sync` or `pip install -e . --group dev`
+
 ### Compiling
 
 While `psygnal` is a pure python package, it is compiled with mypyc to increase
 performance.  To test the compiled version locally, you can run:
 
 ```bash
-make build
+HATCH_BUILD_HOOKS_ENABLE=1 uv sync --force-reinstall
 ```
 
-(which is just an alias for `HATCH_BUILD_HOOKS_ENABLE=1 pip install -e .`)
+(which is also available as `make build` if you have make installed)
 
 ### Debugging
 

.gitignore

@@ -32,18 +32,10 @@ dependencies = [
 # extras
 # https://peps.python.org/pep-0621/#dependencies-optional-dependencies
 [project.optional-dependencies]
-docs = [
-    "griffe==0.25.5",
-    "mkdocs-autorefs==1.0.0",
-    "mkdocs-material==8.5.10",
-    "mkdocs-minify-plugin",
-    "mkdocs==1.4.2",
-    "mkdocstrings-python==0.8.3",
-    "mkdocstrings==0.20.0",
-    "mkdocs-spellcheck[all]",
-]
 proxy = ["wrapt"]
 pydantic = ["pydantic"]
+
+[dependency-groups]
 test = [
     "dask[array]>=2024.0.0",
     "attrs",
@@ -56,19 +48,31 @@ test = [
     "msgspec",
     "toolz",
 ]
-testqt = ["pytest-qt", "qtpy"]
-
+testqt = [{ include-group = "test" }, "pytest-qt", "qtpy"]
+test-codspeed = [{ include-group = "test" }, "pytest-codspeed"]
+docs = [
+    "griffe==0.25.5",
+    "mkdocs-autorefs==1.0.0",
+    "mkdocs-material==8.5.10",
+    "mkdocs-minify-plugin",
+    "mkdocs==1.4.2",
+    "mkdocstrings-python==0.8.3",
+    "mkdocstrings==0.20.0",
+    "mkdocs-spellcheck[all]",
+]
 dev = [
-    "psygnal[test, testqt]",
+    { include-group = "test" },
+    { include-group = "docs" },
     "PyQt6",
     "ipython",
     "mypy",
     "mypy_extensions",
     "pre-commit",
     "pytest-mypy-plugins",
-    "rich",
     "ruff",
     "typing-extensions",
+    "rich>=14.0.0",
+    "pdbpp; sys_platform != 'win32'",
 ]
 
 [project.urls]
@@ -152,7 +156,7 @@ select = [
     "C4",   # flake8-comprehensions
     "B",    # flake8-bugbear
     "A001", # flake8-builtins
-    "TC",  # flake8-typecheck
+    "TC",   # flake8-typecheck
     "TID",  # flake8-tidy-imports
     "RUF",  # ruff-specific rules
 ]
@@ -172,6 +176,7 @@ docstring-code-format = true
 [tool.pytest.ini_options]
 minversion = "6.0"
 testpaths = ["tests"]
+addopts = ["--color=yes"]
 filterwarnings = [
     "error",
     "ignore:The distutils package is deprecated:DeprecationWarning:",