build: use uv for setup and ci (#101)

* wip

* remove no sync

* ci: update Python setup action and pre-commit hook versions; fix typo in ColorStops class

* fix rtd

* ignore w004

* upd

Author: tlambert03

.github/workflows/ci.yml

@@ -21,14 +21,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-      - run: pip install check-manifest && check-manifest
+      - run: pipx run check-manifest
 
   test:
     name: ${{ matrix.platform }} (${{ matrix.python-version }})
     runs-on: ${{ matrix.platform }}
+    env:
+      UV_PRERELEASE: ${{ github.event_name == 'schedule' && 'allow' || 'if-necessary-or-explicit' }}
     strategy:
       fail-fast: false
       matrix:
@@ -38,88 +37,81 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v6
         with:
           python-version: ${{ matrix.python-version }}
-          cache-dependency-path: "pyproject.toml"
-          cache: "pip"
-
-      - uses: tlambert03/setup-qt-libs@v1
-
-      - name: Install dependencies
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
 
-        run: |
-          python -m pip install -U pip
-          python -m pip install -e .[test_min]
+      - name: Run min test
+        run: uv run --no-dev --group test_min pytest -v
 
-      - name: Run test
-        run: pytest -v
+      - uses: pyvista/setup-headless-display-action@v3
+        with:
+          qt: true
 
-      - name: Install third-party dependencies
-        if: runner.os != 'Windows'
-        run: |
-          python -m pip install -e .[test_thirdparty] ${{ github.event_name == 'schedule' && '--pre' || ''  }}
-          python -m pip install PyQt6==6.8.1
+      - name: Run full test
+        run: uv run --no-dev --group test_thirdparty coverage run -p -m pytest -v
 
-      - name: Run test
-        if: runner.os != 'Windows'
-        uses: aganders3/[email protected]
+      - name: Upload coverage
+        uses: actions/upload-artifact@v4
         with:
-          run: pytest -v --cov=cmap --cov-report=xml --cov-report=term-missing
+          name: covreport-${{ matrix.platform }}-py${{ matrix.python-version }}
+          path: ./.coverage*
+          include-hidden-files: true
 
-      - name: Coverage
-        if: runner.os != 'Windows'
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+  upload_coverage:
+    if: always()
+    needs: [test]
+    uses: pyapp-kit/workflows/.github/workflows/upload-coverage.yml@v2
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
 
   test-pyinstaller-build:
     name: Test pyinstaller
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: 3.12
-    - name: Install package and dev dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install .
-        pip install pytest pyinstaller
-    - name: Unit tests
-      run: pytest -v --pyargs cmap.__pyinstaller
-
-  deploy:
-    name: Deploy
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install package and dev dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install pytest pyinstaller
+      - name: Unit tests
+        run: pytest -v --pyargs cmap.__pyinstaller
+
+  build-and-inspect-package:
+    name: Build & inspect package.
     needs: test
-    if: success() && startsWith(github.ref, 'refs/tags/') && github.event_name != 'schedule'
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: hynek/build-and-inspect-python-package@v2
 
+  upload-to-pypi:
+    name: Upload package to PyPI
+    needs: build-and-inspect-package
+    if: success() && startsWith(github.ref, 'refs/tags/') && github.event_name != 'schedule'
+    runs-on: ubuntu-latest
     permissions:
       id-token: write
       contents: write
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Download built artifact to dist/
+        uses: actions/download-artifact@v4
         with:
-          fetch-depth: 0
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-
-      - name: 👷 Build
-        run: |
-          python -m pip install build
-          python -m build
-
+          name: Packages
+          path: dist
       - name: 🚢 Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
-
       - uses: softprops/action-gh-release@v2
         with:
           generate_release_notes: true
-          files: "./dist/*"
+          files: './dist/*'

.github/workflows/docs.yml

@@ -10,9 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v6
         with:
-          python-version: '3.12'
-      - run: |
-          pip install -e .[docs]
-      - run: mkdocs gh-deploy --strict --force
+          python-version: 3.12
+      - run: uv run --group docs mkdocs gh-deploy --strict --force

.gitignore

@@ -111,3 +111,4 @@ src/cmap/_version.py
 docs/assets/_data/
 
 .ruff_cache/
+uv.lock

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
         args: [--autofix]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.4
+    rev: v0.11.10
     hooks:
       - id: ruff
         args: [--fix, --unsafe-fixes]

.readthedocs.yaml

@@ -3,17 +3,14 @@
 version: 2
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-24.04
   tools:
-    python: "3.10"
+    python: "3.12"
+  jobs:
+    post_install:
+      - pip install uv
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs --link-mode=copy
 
 mkdocs:
   configuration: mkdocs.yml
   fail_on_warning: true
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs

pyproject.toml

@@ -25,31 +25,17 @@ classifiers = [
 dynamic = ["version"]
 dependencies = ["numpy"]
 
-# extras
-# https://peps.python.org/pep-0621/#dependencies-optional-dependencies
-[project.optional-dependencies]
-docs = [
-    'colorcet',
-    'colorspacious',
-    'imageio',
-    'mkdocs-gen-files',
-    'mkdocs-literate-nav',
-    'mkdocs-api-autonav',
-    'mkdocs-material',
-    'mkdocs-minify-plugin',
-    'mkdocs',
-    'mkdocstrings-python',
-    'natsort',
-]
+[dependency-groups]
 test_min = ["pytest>=6.0"]
-test = ["cmap[test_min]", "pytest-cov"]
+test = [{ include-group = "test_min" }, "pytest-cov"]
 test_thirdparty = [
-    "cmap[test]",
+    { include-group = "test" },
     "bokeh",
     "colorspacious",
     "colour",
     "matplotlib",
     "napari>=0.5.0",
+    "PyQt6==6.8.1",
     "numba",
     "numba<0.61; python_version<'3.12'",
     "plotly",
@@ -64,16 +50,32 @@ test_thirdparty = [
     "vispy>=0.14",
 ]
 dev = [
-    "cmap[test_thirdparty]",
+    { include-group = "test_thirdparty" },
     "ipython",
     "mypy",
     "pdbpp",
-    "pre-commit",
+    "pre-commit-uv",
     "pytest",
     "rich",
     "ruff",
     "pyqt6",
 ]
+docs = [
+    'colorcet',
+    'colorspacious',
+    'imageio',
+    'mkdocs-gen-files',
+    'mkdocs-literate-nav',
+    'mkdocs-api-autonav',
+    'mkdocs-material',
+    'mkdocs-minify-plugin',
+    'mkdocs',
+    'mkdocstrings-python',
+    'natsort',
+]
+
+[tool.uv.sources]
+cmap = { workspace = true }
 
 [project.entry-points."pyinstaller40"]
 hook-dirs = "cmap.__pyinstaller:get_hook_dirs"
@@ -193,3 +195,6 @@ ignore = [
     "mkdocs.yml",
     ".readthedocs.yaml",
 ]
+
+[tool.check-wheel-contents]
+ignore = ["W004"]

src/cmap/_colormap.py

@@ -998,7 +998,7 @@ def __getitem__(
     def __reversed__(self) -> Iterator[ColorStop]:
         # this for the reversed() builtin ... when iterating single
         # ColorStops.  But see the reversed() method below for when
-        # you want to create a new ColorStops object that is "permantently"
+        # you want to create a new ColorStops object that is "permanently"
         # reversed.
         for pos, *rgba in self._stops[::-1]:
             # reverse the colors, but not the positions
@@ -1399,7 +1399,7 @@ def _mpl_segmentdata_to_stops(
         alpha = np.ones_like(all_positions)
 
     rgba = np.stack([*rgb, alpha], axis=1)
-    return [(a, tuple(b)) for a, b in zip(all_positions, rgba.tolist())]  # type: ignore
+    return [(a, tuple(b)) for a, b in zip(all_positions, rgba.tolist())]
 
 
 def _make_identifier(name: str) -> str:

tests/test_third_party.py

@@ -165,6 +165,7 @@ def test_gee() -> None:
     assert alt[-1] == "0000FF"
 
 
+@pytest.mark.xfail(reason="viscm is unmaintained")
 def test_viscm(tmp_path: Path) -> None:
     pytest.importorskip("viscm")
     # NOT using importorskip here because there IS an error import viscm