Merge pull request #113 from dh-tech/feature/uv-github-actions

Try using uv for unit test workflow

Author: rlskoeser

.github/workflows/check.yml

@@ -17,23 +17,28 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: "3.12"
-          cache: 'pip'
-          cache-dependency-path: '**/pyproject.toml'
-      - name: Install package with development dependencies
-        run: pip install -e ".[dev]"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Install package with check dependencies
+        run: uv sync --extra check
 
       # check with ruff
       - name: Run ruff
-        run: ruff check
+        run: uv run ruff check
 
       # check docs build
       - name: Check that documentation builds with no errors or warnings
-        run: sphinx-build docs docs/_build --fail-on-warning
+        run: uv run sphinx-build docs docs/_build --fail-on-warning
 
       # check types with mypy
       - name: Check types in python src directory; install needed types
-        run: mypy --install-types --non-interactive src
+        run: uv run mypy --install-types --non-interactive src
 
       # use treon to make sure that example notebooks run
       - name: Check jupyter notebooks with treon
-        run: treon
+        run: uv run treon

.github/workflows/unit_tests.yml

@@ -26,24 +26,31 @@ jobs:
         working-directory: .
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+
+      # use github python action instead of uv to take advantage of caching
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
-          cache: 'pip'
-          cache-dependency-path: '**/pyproject.toml'
-      - name: Install package with dependencies
-        run: pip install -e ".[test]"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Install package with dev and test dependencies
+        run: uv sync --extra test
 
       # for all versions but the one we use for code coverage, run normally
       - name: Run unit tests normally
-        run: pytest
+        run: uv run pytest
         if: ${{ matrix.python != env.COV_PYTHON_VERSION }}
 
       # run code coverage in one version only
       - name: Run unit tests with code coverage reporting
-        run: pytest --cov=undate
+        run: uv run pytest --cov=undate
         if: ${{ matrix.python == env.COV_PYTHON_VERSION }}
       - name: Upload test coverage to Codecov
         uses: codecov/codecov-action@v3

pyproject.toml

@@ -49,14 +49,14 @@ classifiers = [
 [project.optional-dependencies]
 docs = ["sphinx>=7.0.0", "alabaster", "myst-parser", "myst-parser[linkify]"]
 test = ["pytest>=7.2", "pytest-ordering", "pytest-cov"]
+notebooks = ["jupyterlab", "pandas", "treon"]
+check = ["undate[docs]", "undate[notebooks]", "mypy", "ruff"]
 dev = [
-    "ruff",
     "pre-commit>=2.20.0",
     "twine",
     "wheel",
     "build",
-    "mypy",
-    "treon",
+    "undate[check]",
     "undate[docs]",
     "undate[test]",
 ]