⬆️ Migrate to uv

Author: DoctorJohn

.github/dependabot.yml

@@ -8,7 +8,7 @@ updates:
     commit-message:
       prefix: ⬆
   # Python
-  - package-ecosystem: "pip"
+  - package-ecosystem: "uv"
     directory: "/"
     schedule:
       interval: "daily"

.github/workflows/build-docs.yml

@@ -8,10 +8,6 @@ on:
       - opened
       - synchronize
 
-env:
-  UV_SYSTEM_PYTHON: 1
-
-
 jobs:
   changes:
     runs-on: ubuntu-latest
@@ -32,8 +28,8 @@ jobs:
             - README.md
             - docs/**
             - docs_src/**
-            - requirements-docs.txt
             - pyproject.toml
+            - uv.lock
             - mkdocs.yml
             - mkdocs.env.yml
             - .github/workflows/build-docs.yml
@@ -54,25 +50,24 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: "3.11"
+          python-version-file: ".python-version"
       - name: Setup uv
         uses: astral-sh/setup-uv@v7
         with:
-          version: "0.4.15"
           enable-cache: true
           cache-dependency-glob: |
-            requirements**.txt
             pyproject.toml
+            uv.lock
       - name: Install docs extras
-        run: uv pip install -r requirements-docs.txt
+        run: uv sync --locked --group docs
       - uses: actions/cache@v4
         with:
           key: mkdocs-cards-${{ github.ref }}
           path: .cache
       - name: Verify README
-        run: python ./scripts/docs.py verify-readme
+        run: uv run ./scripts/docs.py verify-readme
       - name: Build Docs
-        run: python ./scripts/docs.py build
+        run: uv run ./scripts/docs.py build
       - uses: actions/upload-artifact@v5
         with:
           name: docs-site

.github/workflows/deploy-docs.yml

@@ -12,9 +12,6 @@ permissions:
   pull-requests: write
   statuses: write
 
-env:
-  UV_SYSTEM_PYTHON: 1
-
 jobs:
   deploy-docs:
     runs-on: ubuntu-latest
@@ -27,19 +24,18 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: "3.11"
+          python-version-file: ".python-version"
       - name: Setup uv
         uses: astral-sh/setup-uv@v7
         with:
-          version: "0.4.15"
           enable-cache: true
           cache-dependency-glob: |
-            requirements**.txt
             pyproject.toml
+            uv.lock
       - name: Install GitHub Actions dependencies
-        run: uv pip install -r requirements-github-actions.txt
+        run: uv sync --locked --group github-actions
       - name: Deploy Docs Status Pending
-        run: python ./scripts/deploy_docs_status.py
+        run: uv run ./scripts/deploy_docs_status.py
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_SHA: ${{ github.event.workflow_run.head_sha }}
@@ -70,14 +66,14 @@ jobs:
           command: pages deploy ./site --project-name=${{ env.PROJECT_NAME }} --branch=${{ env.BRANCH }}
       - name: Deploy Docs Status Error
         if: failure()
-        run: python ./scripts/deploy_docs_status.py
+        run: uv run ./scripts/deploy_docs_status.py
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_SHA: ${{ github.event.workflow_run.head_sha }}
           RUN_ID: ${{ github.run_id }}
           STATE: "error"
       - name: Comment Deploy
-        run: python ./scripts/deploy_docs_status.py
+        run: uv run ./scripts/deploy_docs_status.py
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DEPLOY_URL: ${{ steps.deploy.outputs.deployment-url }}

.github/workflows/publish.yml

@@ -21,17 +21,22 @@ jobs:
           - sqlmodel-slim
     permissions:
       id-token: write
+      contents: read
     steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
       - uses: actions/checkout@v6
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: "3.11"
-      - name: Install build dependencies
-        run: pip install build
+          python-version-file: ".python-version"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
       - name: Build distribution
+        run: uv build
         env:
           TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
-        run: python -m build
       - name: Publish
-        uses: pypa/gh-action-pypi-publish@v1.13.0
+        run: uv publish

.github/workflows/smokeshow.yml

@@ -8,24 +8,21 @@ on:
 permissions:
   statuses: write
 
-env:
-  UV_SYSTEM_PYTHON: 1
-
 jobs:
   smokeshow:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: '3.13'
+          python-version-file: ".python-version"
       - name: Setup uv
         uses: astral-sh/setup-uv@v7
         with:
           cache-dependency-glob: |
-            requirements**.txt
             pyproject.toml
-      - run: uv pip install -r requirements-github-actions.txt
+            uv.lock
+      - run: uv sync --locked --group github-actions
       - uses: actions/download-artifact@v6
         with:
           name: coverage-html

.github/workflows/test-redistribute.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: "3.10"
+          python-version-file: ".python-version"
       - name: Install build dependencies
         run: pip install build
       - name: Build source distribution
@@ -40,7 +40,7 @@ jobs:
       - name: Install test dependencies
         run: |
           cd dist/sqlmodel*/
-          pip install -r requirements-tests.txt
+          pip install --group dev --editable .
         env:
           TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
       - name: Run source distribution tests

.github/workflows/test.yml

@@ -19,7 +19,7 @@ on:
     - cron: "0 0 * * 1"
 
 env:
-  UV_SYSTEM_PYTHON: 1
+  UV_NO_SYNC: true
 
 jobs:
   test:
@@ -53,6 +53,8 @@ jobs:
             pydantic-version: pydantic-v2
       fail-fast: false
     runs-on: ${{ matrix.os }}
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
     steps:
       - uses: actions/checkout@v6
       - name: Set up Python
@@ -62,19 +64,18 @@ jobs:
       - name: Setup uv
         uses: astral-sh/setup-uv@v7
         with:
-          version: "0.4.15"
           enable-cache: true
           cache-dependency-glob: |
-            requirements**.txt
             pyproject.toml
+            uv.lock
       # Allow debugging with tmate
       - name: Setup tmate session
         uses: mxschmitt/action-tmate@v3
         if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
         with:
           limit-access-to-actor: true
       - name: Install Dependencies
-        run: uv pip install -r requirements-tests.txt
+        run: uv sync --locked --all-extras --dev
       - name: Install Pydantic v1
         if: matrix.pydantic-version == 'pydantic-v1'
         run: uv pip install --upgrade "pydantic>=1.10.0,<2.0.0"
@@ -83,10 +84,10 @@ jobs:
         run: uv pip install --upgrade "pydantic>=2.0.2,<3.0.0"
       - name: Lint
         if: matrix.pydantic-version == 'pydantic-v2' && matrix.python-version != '3.8'
-        run: bash scripts/lint.sh
+        run: uv run bash scripts/lint.sh
       - run: mkdir coverage
       - name: Test
-        run: bash scripts/test.sh
+        run: uv run bash scripts/test.sh
         env:
           COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}-${{ matrix.pydantic-version }}
           CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
@@ -105,33 +106,32 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: '3.13'
+          python-version-file: ".python-version"
       - name: Setup uv
         uses: astral-sh/setup-uv@v7
         with:
-          version: "0.4.15"
           enable-cache: true
           cache-dependency-glob: |
-            requirements**.txt
             pyproject.toml
+            uv.lock
       - name: Get coverage files
         uses: actions/download-artifact@v6
         with:
           pattern: coverage-*
           path: coverage
           merge-multiple: true
       - name: Install Dependencies
-        run: uv pip install -r requirements-tests.txt
+        run: uv sync --locked --all-extras --dev
       - run: ls -la coverage
-      - run: coverage combine coverage
-      - run: coverage html --title "Coverage for ${{ github.sha }}"
+      - run: uv run coverage combine coverage
+      - run: uv run coverage html --title "Coverage for ${{ github.sha }}"
       - name: Store coverage HTML
         uses: actions/upload-artifact@v5
         with:
           name: coverage-html
           path: htmlcov
           include-hidden-files: true
-      - run: coverage report --fail-under=99
+      - run: uv run coverage report --fail-under=99
 
   # https://github.com/marketplace/actions/alls-green#why
   alls-green:  # This job does nothing and is only used for the branch protection

.python-version

@@ -0,0 +1 @@
+3.9

docs/contributing.md

@@ -6,18 +6,14 @@ First, you might want to see the basic ways to [help SQLModel and get help](help
 
 If you already cloned the <a href="https://github.com/fastapi/sqlmodel" class="external-link" target="_blank">sqlmodel repository</a> and you want to deep dive in the code, here are some guidelines to set up your environment.
 
-### Virtual Environment
+### Install Requirements Using `uv`
 
-Follow the instructions to create and activate a [virtual environment](virtual-environments.md){.internal-link target=_blank} for the internal code of `sqlmodel`.
-
-### Install Requirements Using `pip`
-
-After activating the environment, install the required packages:
+Create a virtual environment and install the required packages in one command:
 
 <div class="termy">
 
 ```console
-$ pip install -r requirements.txt
+$ uv sync
 
 ---> 100%
 ```

pyproject.toml

@@ -48,6 +48,46 @@ Repository = "https://github.com/fastapi/sqlmodel"
 Issues = "https://github.com/fastapi/sqlmodel/issues"
 Changelog = "https://sqlmodel.tiangolo.com/release-notes/"
 
+[dependency-groups]
+dev = [
+    { include-group = "docs" },
+    "black>=22.10",
+    "coverage[toml]>=6.2,<8.0",
+    "dirty-equals==0.9.0",
+    "fastapi>=0.103.2",
+    "httpx==0.28.1",
+    "jinja2==3.1.6",
+    "mypy==1.14.1 ; python_full_version < '3.9'",
+    "mypy==1.18.2 ; python_full_version >= '3.9'",
+    "pre-commit>=2.17.0,<5.0.0",
+    "pytest>=7.0.1,<9.0.0",
+    "ruff==0.14.8",
+    "typing-extensions==4.13.2 ; python_full_version < '3.9'",
+    "typing-extensions==4.15.0 ; python_full_version >= '3.9'",
+]
+docs = [
+    "black>=22.10",
+    "cairosvg==2.8.2 ; python_full_version >= '3.9'",
+    "griffe-typingdoc==0.3.0 ; python_full_version >= '3.9'",
+    "griffe-warnings-deprecated==1.1.0 ; python_full_version >= '3.9'",
+    "markdown-include-variants==0.0.5 ; python_full_version >= '3.9'",
+    "mdx-include>=1.4.1,<2.0.0",
+    "mkdocs-macros-plugin==1.5.0",
+    "mkdocs-material==9.7.0",
+    "mkdocs-redirects>=1.2.1,<1.3.0",
+    "mkdocstrings[python]==0.30.1 ; python_full_version >= '3.9'",
+    "pillow==11.3.0 ; python_full_version >= '3.9'",
+    "pyyaml>=5.3.1,<7.0.0",
+    "typer==0.20.0",
+]
+github-actions = [
+    "httpx>=0.27.0,<0.29.0",
+    "pydantic>=2.5.3,<3.0.0",
+    "pydantic-settings>=2.1.0,<3.0.0",
+    "pygithub>=2.3.0,<3.0.0",
+    "smokeshow>=0.5.0",
+]
+
 [tool.pdm]
 version = { source = "file", path = "sqlmodel/__init__.py" }
 distribution = true
@@ -56,10 +96,9 @@ distribution = true
 source-includes = [
     "tests/",
     "docs_src/",
-    "requirements*.txt",
     "scripts/",
     "sqlmodel/sql/expression.py.jinja2",
-    ]
+]
 
 [tool.tiangolo._internal-slim-build.packages.sqlmodel-slim.project]
 name = "sqlmodel-slim"