Configure ty type checker, migrate CI to uv

- Add ty configuration: python-version 3.10, exclude tests/ and docs/
- All ty rules at default severity (no downgrades)
- Add lint CI job (ruff check, ruff format, ty check)
- Migrate test matrix job from pip to uv
- Remove redundant uv-test job (now covered by test matrix)
- Keep multiarch job on pip (uv not available on ppc64le)
- Move docs from optional dependency to dependency group
- Include docs group in test group (tests/test_docs.py needs docutils)
- Migrate ReadTheDocs to uv

Author: Lotram

.github/workflows/bugwarrior.yml

@@ -14,26 +14,18 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
       - name: Run tests
         run: |
           sudo apt-get update -qq
-          sudo apt-get install -qq -y \
-            libffi-dev libssl-dev python3-venv taskwarrior
+          sudo apt-get install -qq -y taskwarrior
           task --version
-
-          mkdir .venv
-          python3 -m venv .venv
-          source .venv/bin/activate
-          pip install --upgrade pip setuptools
-
-          pip install -e ".[all]"
-
-          bugwarrior --version
-          pytest
+          uv sync --all-extras --group test --python ${{ matrix.python-version }}
+          uv run bugwarrior --version
+          uv run pytest
+  # Cannot migrate to uv: astral-sh/setup-uv does not support ppc64le,
+  # and uraimo/run-on-arch-action runs inside a Docker container.
   bugwarrior-multiarch-test:
     runs-on: ubuntu-latest
     # We're currently seeing these complete in 10-30 minutes.
@@ -64,32 +56,26 @@ jobs:
             mkdir .venv
             python3 -m venv .venv
             source .venv/bin/activate
-            pip install --upgrade pip setuptools
+            pip install --upgrade "pip>=25.1" setuptools
 
             pip install -e .[all]
+            pip install --group test
 
             bugwarrior --version
             pytest
-  bugwarrior-development-uv-test:
+  bugwarrior-lint:
     runs-on: ubuntu-latest
-    # We're currently seeing these complete in 1 minute.
     timeout-minutes: 5
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update -qq
-          sudo apt-get install -qq -y \
-            libffi-dev libssl-dev taskwarrior
-          task --version
       - name: Install uv
         uses: astral-sh/setup-uv@v6
-      - name: Install Editable Installation
-        run: uv sync --all-extras
-      - name: Run tests
-        run: |
-          uv run bugwarrior --version
-          uv run pytest
+      - name: Install dependencies
+        run: uv sync --all-extras --group dev
+      - name: Ruff check
+        run: uv run ruff check
+      - name: Ruff format
+        run: uv run ruff format --check
+      - name: Type check
+        run: uv run ty check

.readthedocs.yaml

@@ -1,6 +1,7 @@
 # .readthedocs.yaml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# uv setup: https://docs.readthedocs.com/platform/stable/build-customization.html#install-dependencies-with-uv
 
 # Required
 version: 2
@@ -10,11 +11,12 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.10"
-
-# Optionally declare the Python requirements required to build your docs
-python:
-   install:
-      - method: pip
-        path: .
-        extra_requirements:
-           - all
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    create_environment:
+      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --all-extras --group docs

pyproject.toml

@@ -35,24 +35,10 @@ jira = ["jira>=3.10.0"]
 kanboard = ["kanboard"]
 keyring = ["keyring"]
 phabricator = ["phabricator"]
-test = [
-   # sphinx-inline-tabs is incompatible with docutils-0.22 https://github.com/pradyunsg/sphinx-inline-tabs/pull/51
-   "docutils<0.22",
-   "pytest",
-   "pytest-subtests",
-   "responses",
-   "ruff",
-   "sphinx>=1.0,<9.0 ; python_version <= '3.10'",
-   "sphinx>=9.0.3 ; python_version >= '3.11'",
-   "sphinx-click",
-   "sphinx-inline-tabs",
-   # To make this installable with uvx/pipx and no additional options needed.
-   "setuptools",
-]
 todoist = ["todoist_api_python>=3.0.0"]
 trac = ["offtrac"]
 
-all = ["bugwarrior[bts,bugzilla,gmail,ini2toml,jira,kanboard,keyring,phabricator,test,todoist,trac]"]
+all = ["bugwarrior[bts,bugzilla,gmail,ini2toml,jira,kanboard,keyring,phabricator,todoist,trac]"]
 
 [project.urls]
 documentation = "https://bugwarrior.readthedocs.io/en/stable/"
@@ -112,6 +98,37 @@ max-line-length = 100
 [tool.setuptools.packages.find]
 include = ["bugwarrior*"]
 
+[tool.ty.environment]
+python-version = "3.10"
+
+[tool.ty.src]
+exclude = ["tests/", "bugwarrior/docs/"]
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
+
+# PEP 735 — Dependency Groups in pyproject.toml
+# https://peps.python.org/pep-0735/
+[dependency-groups]
+docs = [
+    # sphinx-inline-tabs is incompatible with docutils-0.22 https://github.com/pradyunsg/sphinx-inline-tabs/pull/51
+    "docutils<0.22",
+    "sphinx>=1.0,<9.0 ; python_version <= '3.10'",
+    "sphinx>=9.0.3 ; python_version >= '3.11'",
+    "sphinx-click",
+    "sphinx-inline-tabs",
+    # To make this installable with uvx/pipx and no additional options needed.
+    "setuptools",
+]
+test = [
+    {include-group = "docs"},
+    "pytest",
+    "pytest-subtests",
+    "responses",
+]
+dev = [
+    {include-group = "test"},
+    "ruff",
+    "ty>=0.0.23",
+]