Use uv to manage dev dependencies (typeddjango#2698)

Author: UnknownPlatypus

.github/workflows/test.yml

@@ -7,6 +7,10 @@ on:
   pull_request:
   workflow_dispatch:
 
+env:
+  UV_FROZEN: true # https://docs.astral.sh/uv/configuration/environment/#uv_frozen
+  UV_NO_SYNC: true # prevent `uv run` cmd from bringing very dev dependencies
+
 permissions:
   contents: read
 
@@ -24,24 +28,26 @@ jobs:
       fail-fast: false
     steps:
       - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
-        run: |
-          pip install -U pip
-          pip install -r ./requirements.txt
+        run: uv sync --no-dev --group tests
 
       - name: Run mypy on plugin code
-        run: mypy --strict mypy_django_plugin
-
+        run: uv run mypy --strict mypy_django_plugin
       - name: Run mypy on ext code
-        run: mypy --strict ext
+        run: uv run mypy --strict ext
       - name: Run mypy on scripts and utils
-        run: mypy --strict scripts
+        run: uv run mypy --strict scripts
       - name: Run mypy on stubs
-        run: mypy --cache-dir=/dev/null --no-incremental django-stubs
+        run: uv run mypy --cache-dir=/dev/null --no-incremental django-stubs
+      - name: Run mypy on the test cases
+        run: uv run mypy --strict tests
 
   test:
     timeout-minutes: 15
@@ -57,20 +63,20 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install binutils libproj-dev gdal-bin
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
-        run: |
-          pip install -U pip
-          pip install -r ./requirements.txt
+        run: uv sync --no-dev --group tests
 
       # Must match `shard` definition in the test matrix:
       - name: Run pytest tests
-        run: PYTHONPATH='.' pytest --num-shards=4 --shard-id=${{ matrix.shard }} -n auto tests
-      - name: Run mypy on the test cases
-        run: mypy --strict tests
+        run: uv run pytest --num-shards=4 --shard-id=${{ matrix.shard }} -n auto tests
+
 
   stubtest:
     timeout-minutes: 10
@@ -85,17 +91,18 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install binutils libproj-dev gdal-bin
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
-        run: |
-          pip install -U pip
-          pip install -r ./requirements.txt
+        run: uv sync --no-dev --group tests
 
       - name: Run stubtest
-        run: ./scripts/stubtest.sh
+        run: uv run ./scripts/stubtest.sh
 
   run-pyright:
     timeout-minutes: 10
@@ -106,14 +113,20 @@ jobs:
       fail-fast: false
     steps:
       - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
-        run: |
-          pip install -U pip
-          pip install -r ./requirements.txt
+        run: uv sync --no-dev --group pyright
+
+      # See https://github.com/jakebailey/pyright-action#providing-a-pyright-version-sourced-from-preexisting-dependencies
+      - name: Add venv to path
+        run: echo "$PWD/.venv/bin" >> $GITHUB_PATH
+
       - name: Run pyright on the stubs
         uses: jakebailey/pyright-action@v2
         with:
@@ -140,19 +153,18 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install binutils libproj-dev gdal-bin
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
-        run: |
-          pip install -U pip
-          pip install -r ./requirements.txt
-          pip install "Django==${{ matrix.django-version }}"
-          pip check
+        run: uv sync --no-dev --group tests
 
       - name: Run django-stubs-ext tests
-        run: PYTHONPATH='.' pytest ext
+        run: uv run --with "django==${{ matrix.django-version }}" pytest ext
 
   build-and-check:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -30,23 +30,19 @@ Additionally, the following resources might be useful:
 ### Repository Setup
 
 As a first step you will need to fork this repository and clone your fork locally.
-In order to be able to continuously sync your fork with the origin repository's master branch, you will need to set up an upstream master. To do so follow this [official github guide](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).
+In order to be able to continuously sync your fork with the origin repository's master branch, you will need to set up an upstream master.
+To do so follow this [official github guide](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).
 
 ### Dependency Setup
+We use [uv](https://github.com/astral-sh/uv) to manage our dev dependencies.
+To install it, see their [installation guide](https://docs.astral.sh/uv/getting-started/installation/)
 
-After your repository is setup you will then need to create and activate a git ignored virtual env, e.g.:
-
+Once it's done, simply run the following command to automatically setup a virtual environment and install dev dependencies:
 ```bash
-python3 -m venv .venv
+uv sync
 source .venv/bin/activate
 ```
 
-Then install the dev requirements:
-
-```bash
-pip install -r ./requirements.txt
-```
-
 Finally, install the pre-commit hooks:
 
 ```bash

pyproject.toml

@@ -45,15 +45,42 @@ compatible-mypy = ["mypy>=1.13,<1.16"]
 oracle = ["oracledb"]
 redis = ["redis", "types-redis"]
 
+[dependency-groups]
+tests = [
+    # Dev tools:
+    "pytest==8.3.5",
+    "pytest-mypy-plugins==3.2.0",
+    "pytest-shard==0.1.2",
+    "pytest-xdist==3.7.0",
+    # Django deps:
+    "django==5.2.1",
+    "mysqlclient==2.2.7",
+    "psycopg2-binary==2.9.10",
+    "jinja2==3.1.6",
+    "pyyaml==6.0.2",
+    # typing:
+    "mypy==1.15.0",
+    "django-stubs[compatible-mypy,oracle,redis]",
+]
+pyright = ["pyright==1.1.401"]
+
+dev = [
+    {include-group = "tests"},
+    {include-group = "pyright"},
+]
+
 [project.urls]
 Homepage = "https://github.com/typeddjango/django-stubs"
 Funding = "https://github.com/sponsors/typeddjango"
 "Release notes" = "https://github.com/typeddjango/django-stubs/releases"
 
+[tool.uv.sources]
+django-stubs = { workspace = true }
+django-stubs-ext = { path = "ext", editable = true }
+
 [tool.hatch.build]
 packages = ["django-stubs", "mypy_django_plugin"]
 
-
 [tool.codespell]
 ignore-words-list = "aadd,acount,nam,asend"