⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 3 commits into from
Jan 4, 2026
Merged

⬆️ Migrate to uv #1688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e51101a
⬆️ Migrate to uv
DoctorJohn Dec 23, 2025
a7b90b0
Stop installing unneeded deps
DoctorJohn Jan 2, 2026
69e13be
👷 Update .github/workflows/smokeshow.yml
tiangolo Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/dependabot.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
commit-message:
prefix: ⬆
# Python
- package-ecosystem: "pip"
- package-ecosystem: "uv"
directory: "/"
schedule:
interval: "daily"
Expand Down
17 changes: 6 additions & 11 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
- opened
- synchronize

env:
UV_SYSTEM_PYTHON: 1


jobs:
changes:
runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
- uses: actions/cache@v5
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@v6
with:
name: docs-site
Expand Down
16 changes: 6 additions & 10 deletions .github/workflows/deploy-docs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
pull-requests: write
statuses: write

env:
UV_SYSTEM_PYTHON: 1

jobs:
deploy-docs:
runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down
7 changes: 2 additions & 5 deletions .github/workflows/pre-commit.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.14"
python-version-file: ".python-version"
- name: Setup uv
uses: astral-sh/setup-uv@v7
with:
cache-dependency-glob: |
requirements**.txt
pyproject.toml
uv.lock
- name: Install Dependencies
run: |
uv venv
uv pip install -r requirements.txt
run: uv sync --locked
- name: Run prek - pre-commit
id: precommit
run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down
15 changes: 10 additions & 5 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
11 changes: 4 additions & 7 deletions .github/workflows/smokeshow.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
- uses: actions/download-artifact@v7
with:
name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
- name: Upload coverage to Smokeshow
run: |
for i in 1 2 3 4 5; do
if smokeshow upload htmlcov; then
if uv run smokeshow upload htmlcov; then
echo "Smokeshow upload success!"
break
fi
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test-redistribute.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
- name: Install test dependencies
run: |
cd dist/sqlmodel*/
pip install -r requirements-tests.txt
pip install --group tests --editable .
env:
TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
- name: Run source distribution tests
Expand Down
24 changes: 12 additions & 12 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
- cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
test:
Expand All@@ -42,6 +42,8 @@ jobs:
python-version: "3.13"
fail-fast: false
runs-on: ${{ matrix.os }}
env:
UV_PYTHON: ${{ matrix.python-version }}
steps:
- uses: actions/checkout@v6
- name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
- 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 }}
Expand All@@ -85,33 +86,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@v7
with:
pattern: coverage-*
path: coverage
merge-multiple: true
- name: Install Dependencies
run: uv pip install -r requirements-tests.txt
run: uv sync --locked --no-dev --group tests
- 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@v6
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
Expand Down
1 change: 1 addition & 0 deletions .python-version
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9
10 changes: 3 additions & 7 deletions docs/contributing.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down
45 changes: 43 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
{ include-group = "tests" },
"prek>=0.2.24,<1.0.0",
]
docs = [
"black>=22.10",
"cairosvg==2.8.2",
"griffe-typingdoc==0.3.0",
"griffe-warnings-deprecated==1.1.0",
"markdown-include-variants==0.0.8",
"mdx-include>=1.4.1,<2.0.0",
"mkdocs-macros-plugin==1.5.0",
"mkdocs-material==9.7.1",
"mkdocs-redirects>=1.2.1,<1.3.0",
"mkdocstrings[python]==0.30.1",
"pillow==11.3.0",
"pyyaml>=5.3.1,<7.0.0",
"typer==0.21.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",
]
tests = [
"black>=22.10",
"coverage[toml]>=6.2,<8.0",
"dirty-equals==0.11",
"fastapi>=0.103.2,<0.129.0",
"httpx==0.28.1",
"jinja2==3.1.6",
"mypy==1.19.1",
"pre-commit>=2.17.0,<5.0.0",
"pytest>=7.0.1,<9.0.0",
"ruff==0.14.10",
"typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down
2 changes: 0 additions & 2 deletions requirements-docs-tests.txt
View file
Open in desktop

This file was deleted.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Jan 4, 2026
 Merged


⬆️ Migrate to uv
#1688
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e51101a

⬆️ Migrate to uv


DoctorJohn Dec 23, 2025
a7b90b0

Stop installing unneeded deps


DoctorJohn Jan 2, 2026
69e13be

👷 Update .github/workflows/smokeshow.yml


tiangolo Jan 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/dependabot.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
 commit-message:
 prefix: ⬆
 # Python
 - package-ecosystem: "pip"
 - package-ecosystem: "uv"
 directory: "/"
 schedule:
 interval: "daily"
Expand Down

17 changes: 6 additions & 11 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
 - opened
 - synchronize

env:
 UV_SYSTEM_PYTHON: 1


jobs:
 changes:
 runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
 - uses: actions/cache@v5
 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@v6
 with:
 name: docs-site
Expand Down

16 changes: 6 additions & 10 deletions
.github/workflows/deploy-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
 pull-requests: write
 statuses: write

env:
 UV_SYSTEM_PYTHON: 1

jobs:
 deploy-docs:
 runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down

7 changes: 2 additions & 5 deletions
.github/workflows/pre-commit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
 - name: Set up Python
 uses: actions/setup-python@v6
 with:
 python-version: "3.14"
 python-version-file: ".python-version"
 - name: Setup uv
 uses: astral-sh/setup-uv@v7
 with:
 cache-dependency-glob: |
 requirements**.txt
 pyproject.toml
 uv.lock
 - name: Install Dependencies
 run: |
 uv venv
 uv pip install -r requirements.txt
 run: uv sync --locked
 - name: Run prek - pre-commit
 id: precommit
 run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down

15 changes: 10 additions & 5 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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

11 changes: 4 additions & 7 deletions
.github/workflows/smokeshow.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
 - uses: actions/download-artifact@v7
 with:
 name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
 - name: Upload coverage to Smokeshow
 run: |
 for i in 1 2 3 4 5; do
 if smokeshow upload htmlcov; then
 if uv run smokeshow upload htmlcov; then
 echo "Smokeshow upload success!"
 break
 fi
Expand Down

4 changes: 2 additions & 2 deletions
.github/workflows/test-redistribute.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
 - name: Install test dependencies
 run: |
 cd dist/sqlmodel*/
 pip install -r requirements-tests.txt
 pip install --group tests --editable .
 env:
 TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
 - name: Run source distribution tests
Expand Down

24 changes: 12 additions & 12 deletions
.github/workflows/test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
 - cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
 test:
Expand All@@ -42,6 +42,8 @@ jobs:
 python-version: "3.13"
 fail-fast: false
 runs-on: ${{ matrix.os }}
 env:
 UV_PYTHON: ${{ matrix.python-version }}
 steps:
 - uses: actions/checkout@v6
 - name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
 - 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 }}
Expand All@@ -85,33 +86,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@v7
 with:
 pattern: coverage-*
 path: coverage
 merge-multiple: true
 - name: Install Dependencies
 run: uv pip install -r requirements-tests.txt
 run: uv sync --locked --no-dev --group tests
 - 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@v6
 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
Expand Down

1 change: 1 addition & 0 deletions
.python-version

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9

10 changes: 3 additions & 7 deletions
docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down

45 changes: 43 additions & 2 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
 { include-group = "tests" },
 "prek>=0.2.24,<1.0.0",
]
docs = [
 "black>=22.10",
 "cairosvg==2.8.2",
 "griffe-typingdoc==0.3.0",
 "griffe-warnings-deprecated==1.1.0",
 "markdown-include-variants==0.0.8",
 "mdx-include>=1.4.1,<2.0.0",
 "mkdocs-macros-plugin==1.5.0",
 "mkdocs-material==9.7.1",
 "mkdocs-redirects>=1.2.1,<1.3.0",
 "mkdocstrings[python]==0.30.1",
 "pillow==11.3.0",
 "pyyaml>=5.3.1,<7.0.0",
 "typer==0.21.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",
]
tests = [
 "black>=22.10",
 "coverage[toml]>=6.2,<8.0",
 "dirty-equals==0.11",
 "fastapi>=0.103.2,<0.129.0",
 "httpx==0.28.1",
 "jinja2==3.1.6",
 "mypy==1.19.1",
 "pre-commit>=2.17.0,<5.0.0",
 "pytest>=7.0.1,<9.0.0",
 "ruff==0.14.10",
 "typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down

2 changes: 0 additions & 2 deletions
requirements-docs-tests.txt

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Jan 4, 2026
 Merged


⬆️ Migrate to uv
#1688
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e51101a

⬆️ Migrate to uv


DoctorJohn Dec 23, 2025
a7b90b0

Stop installing unneeded deps


DoctorJohn Jan 2, 2026
69e13be

👷 Update .github/workflows/smokeshow.yml


tiangolo Jan 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/dependabot.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
 commit-message:
 prefix: ⬆
 # Python
 - package-ecosystem: "pip"
 - package-ecosystem: "uv"
 directory: "/"
 schedule:
 interval: "daily"
Expand Down

17 changes: 6 additions & 11 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
 - opened
 - synchronize

env:
 UV_SYSTEM_PYTHON: 1


jobs:
 changes:
 runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
 - uses: actions/cache@v5
 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@v6
 with:
 name: docs-site
Expand Down

16 changes: 6 additions & 10 deletions
.github/workflows/deploy-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
 pull-requests: write
 statuses: write

env:
 UV_SYSTEM_PYTHON: 1

jobs:
 deploy-docs:
 runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down

7 changes: 2 additions & 5 deletions
.github/workflows/pre-commit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
 - name: Set up Python
 uses: actions/setup-python@v6
 with:
 python-version: "3.14"
 python-version-file: ".python-version"
 - name: Setup uv
 uses: astral-sh/setup-uv@v7
 with:
 cache-dependency-glob: |
 requirements**.txt
 pyproject.toml
 uv.lock
 - name: Install Dependencies
 run: |
 uv venv
 uv pip install -r requirements.txt
 run: uv sync --locked
 - name: Run prek - pre-commit
 id: precommit
 run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down

15 changes: 10 additions & 5 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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

11 changes: 4 additions & 7 deletions
.github/workflows/smokeshow.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
 - uses: actions/download-artifact@v7
 with:
 name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
 - name: Upload coverage to Smokeshow
 run: |
 for i in 1 2 3 4 5; do
 if smokeshow upload htmlcov; then
 if uv run smokeshow upload htmlcov; then
 echo "Smokeshow upload success!"
 break
 fi
Expand Down

4 changes: 2 additions & 2 deletions
.github/workflows/test-redistribute.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
 - name: Install test dependencies
 run: |
 cd dist/sqlmodel*/
 pip install -r requirements-tests.txt
 pip install --group tests --editable .
 env:
 TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
 - name: Run source distribution tests
Expand Down

24 changes: 12 additions & 12 deletions
.github/workflows/test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
 - cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
 test:
Expand All@@ -42,6 +42,8 @@ jobs:
 python-version: "3.13"
 fail-fast: false
 runs-on: ${{ matrix.os }}
 env:
 UV_PYTHON: ${{ matrix.python-version }}
 steps:
 - uses: actions/checkout@v6
 - name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
 - 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 }}
Expand All@@ -85,33 +86,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@v7
 with:
 pattern: coverage-*
 path: coverage
 merge-multiple: true
 - name: Install Dependencies
 run: uv pip install -r requirements-tests.txt
 run: uv sync --locked --no-dev --group tests
 - 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@v6
 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
Expand Down

1 change: 1 addition & 0 deletions
.python-version

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9

10 changes: 3 additions & 7 deletions
docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down

45 changes: 43 additions & 2 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
 { include-group = "tests" },
 "prek>=0.2.24,<1.0.0",
]
docs = [
 "black>=22.10",
 "cairosvg==2.8.2",
 "griffe-typingdoc==0.3.0",
 "griffe-warnings-deprecated==1.1.0",
 "markdown-include-variants==0.0.8",
 "mdx-include>=1.4.1,<2.0.0",
 "mkdocs-macros-plugin==1.5.0",
 "mkdocs-material==9.7.1",
 "mkdocs-redirects>=1.2.1,<1.3.0",
 "mkdocstrings[python]==0.30.1",
 "pillow==11.3.0",
 "pyyaml>=5.3.1,<7.0.0",
 "typer==0.21.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",
]
tests = [
 "black>=22.10",
 "coverage[toml]>=6.2,<8.0",
 "dirty-equals==0.11",
 "fastapi>=0.103.2,<0.129.0",
 "httpx==0.28.1",
 "jinja2==3.1.6",
 "mypy==1.19.1",
 "pre-commit>=2.17.0,<5.0.0",
 "pytest>=7.0.1,<9.0.0",
 "ruff==0.14.10",
 "typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down

2 changes: 0 additions & 2 deletions
requirements-docs-tests.txt

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Jan 4, 2026
 Merged


⬆️ Migrate to uv
#1688
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e51101a

⬆️ Migrate to uv


DoctorJohn Dec 23, 2025
a7b90b0

Stop installing unneeded deps


DoctorJohn Jan 2, 2026
69e13be

👷 Update .github/workflows/smokeshow.yml


tiangolo Jan 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/dependabot.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
 commit-message:
 prefix: ⬆
 # Python
 - package-ecosystem: "pip"
 - package-ecosystem: "uv"
 directory: "/"
 schedule:
 interval: "daily"
Expand Down

17 changes: 6 additions & 11 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
 - opened
 - synchronize

env:
 UV_SYSTEM_PYTHON: 1


jobs:
 changes:
 runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
 - uses: actions/cache@v5
 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@v6
 with:
 name: docs-site
Expand Down

16 changes: 6 additions & 10 deletions
.github/workflows/deploy-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
 pull-requests: write
 statuses: write

env:
 UV_SYSTEM_PYTHON: 1

jobs:
 deploy-docs:
 runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down

7 changes: 2 additions & 5 deletions
.github/workflows/pre-commit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
 - name: Set up Python
 uses: actions/setup-python@v6
 with:
 python-version: "3.14"
 python-version-file: ".python-version"
 - name: Setup uv
 uses: astral-sh/setup-uv@v7
 with:
 cache-dependency-glob: |
 requirements**.txt
 pyproject.toml
 uv.lock
 - name: Install Dependencies
 run: |
 uv venv
 uv pip install -r requirements.txt
 run: uv sync --locked
 - name: Run prek - pre-commit
 id: precommit
 run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down

15 changes: 10 additions & 5 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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

11 changes: 4 additions & 7 deletions
.github/workflows/smokeshow.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
 - uses: actions/download-artifact@v7
 with:
 name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
 - name: Upload coverage to Smokeshow
 run: |
 for i in 1 2 3 4 5; do
 if smokeshow upload htmlcov; then
 if uv run smokeshow upload htmlcov; then
 echo "Smokeshow upload success!"
 break
 fi
Expand Down

4 changes: 2 additions & 2 deletions
.github/workflows/test-redistribute.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
 - name: Install test dependencies
 run: |
 cd dist/sqlmodel*/
 pip install -r requirements-tests.txt
 pip install --group tests --editable .
 env:
 TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
 - name: Run source distribution tests
Expand Down

24 changes: 12 additions & 12 deletions
.github/workflows/test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
 - cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
 test:
Expand All@@ -42,6 +42,8 @@ jobs:
 python-version: "3.13"
 fail-fast: false
 runs-on: ${{ matrix.os }}
 env:
 UV_PYTHON: ${{ matrix.python-version }}
 steps:
 - uses: actions/checkout@v6
 - name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
 - 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 }}
Expand All@@ -85,33 +86,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@v7
 with:
 pattern: coverage-*
 path: coverage
 merge-multiple: true
 - name: Install Dependencies
 run: uv pip install -r requirements-tests.txt
 run: uv sync --locked --no-dev --group tests
 - 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@v6
 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
Expand Down

1 change: 1 addition & 0 deletions
.python-version

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9

10 changes: 3 additions & 7 deletions
docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down

45 changes: 43 additions & 2 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
 { include-group = "tests" },
 "prek>=0.2.24,<1.0.0",
]
docs = [
 "black>=22.10",
 "cairosvg==2.8.2",
 "griffe-typingdoc==0.3.0",
 "griffe-warnings-deprecated==1.1.0",
 "markdown-include-variants==0.0.8",
 "mdx-include>=1.4.1,<2.0.0",
 "mkdocs-macros-plugin==1.5.0",
 "mkdocs-material==9.7.1",
 "mkdocs-redirects>=1.2.1,<1.3.0",
 "mkdocstrings[python]==0.30.1",
 "pillow==11.3.0",
 "pyyaml>=5.3.1,<7.0.0",
 "typer==0.21.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",
]
tests = [
 "black>=22.10",
 "coverage[toml]>=6.2,<8.0",
 "dirty-equals==0.11",
 "fastapi>=0.103.2,<0.129.0",
 "httpx==0.28.1",
 "jinja2==3.1.6",
 "mypy==1.19.1",
 "pre-commit>=2.17.0,<5.0.0",
 "pytest>=7.0.1,<9.0.0",
 "ruff==0.14.10",
 "typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down

2 changes: 0 additions & 2 deletions
requirements-docs-tests.txt

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Jan 4, 2026
 Merged


⬆️ Migrate to uv
#1688
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e51101a

⬆️ Migrate to uv


DoctorJohn Dec 23, 2025
a7b90b0

Stop installing unneeded deps


DoctorJohn Jan 2, 2026
69e13be

👷 Update .github/workflows/smokeshow.yml


tiangolo Jan 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/dependabot.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
 commit-message:
 prefix: ⬆
 # Python
 - package-ecosystem: "pip"
 - package-ecosystem: "uv"
 directory: "/"
 schedule:
 interval: "daily"
Expand Down

17 changes: 6 additions & 11 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
 - opened
 - synchronize

env:
 UV_SYSTEM_PYTHON: 1


jobs:
 changes:
 runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
 - uses: actions/cache@v5
 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@v6
 with:
 name: docs-site
Expand Down

16 changes: 6 additions & 10 deletions
.github/workflows/deploy-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
 pull-requests: write
 statuses: write

env:
 UV_SYSTEM_PYTHON: 1

jobs:
 deploy-docs:
 runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down

7 changes: 2 additions & 5 deletions
.github/workflows/pre-commit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
 - name: Set up Python
 uses: actions/setup-python@v6
 with:
 python-version: "3.14"
 python-version-file: ".python-version"
 - name: Setup uv
 uses: astral-sh/setup-uv@v7
 with:
 cache-dependency-glob: |
 requirements**.txt
 pyproject.toml
 uv.lock
 - name: Install Dependencies
 run: |
 uv venv
 uv pip install -r requirements.txt
 run: uv sync --locked
 - name: Run prek - pre-commit
 id: precommit
 run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down

15 changes: 10 additions & 5 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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

11 changes: 4 additions & 7 deletions
.github/workflows/smokeshow.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
 - uses: actions/download-artifact@v7
 with:
 name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
 - name: Upload coverage to Smokeshow
 run: |
 for i in 1 2 3 4 5; do
 if smokeshow upload htmlcov; then
 if uv run smokeshow upload htmlcov; then
 echo "Smokeshow upload success!"
 break
 fi
Expand Down

4 changes: 2 additions & 2 deletions
.github/workflows/test-redistribute.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
 - name: Install test dependencies
 run: |
 cd dist/sqlmodel*/
 pip install -r requirements-tests.txt
 pip install --group tests --editable .
 env:
 TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
 - name: Run source distribution tests
Expand Down

24 changes: 12 additions & 12 deletions
.github/workflows/test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
 - cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
 test:
Expand All@@ -42,6 +42,8 @@ jobs:
 python-version: "3.13"
 fail-fast: false
 runs-on: ${{ matrix.os }}
 env:
 UV_PYTHON: ${{ matrix.python-version }}
 steps:
 - uses: actions/checkout@v6
 - name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
 - 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 }}
Expand All@@ -85,33 +86,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@v7
 with:
 pattern: coverage-*
 path: coverage
 merge-multiple: true
 - name: Install Dependencies
 run: uv pip install -r requirements-tests.txt
 run: uv sync --locked --no-dev --group tests
 - 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@v6
 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
Expand Down

1 change: 1 addition & 0 deletions
.python-version

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9

10 changes: 3 additions & 7 deletions
docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down

45 changes: 43 additions & 2 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
 { include-group = "tests" },
 "prek>=0.2.24,<1.0.0",
]
docs = [
 "black>=22.10",
 "cairosvg==2.8.2",
 "griffe-typingdoc==0.3.0",
 "griffe-warnings-deprecated==1.1.0",
 "markdown-include-variants==0.0.8",
 "mdx-include>=1.4.1,<2.0.0",
 "mkdocs-macros-plugin==1.5.0",
 "mkdocs-material==9.7.1",
 "mkdocs-redirects>=1.2.1,<1.3.0",
 "mkdocstrings[python]==0.30.1",
 "pillow==11.3.0",
 "pyyaml>=5.3.1,<7.0.0",
 "typer==0.21.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",
]
tests = [
 "black>=22.10",
 "coverage[toml]>=6.2,<8.0",
 "dirty-equals==0.11",
 "fastapi>=0.103.2,<0.129.0",
 "httpx==0.28.1",
 "jinja2==3.1.6",
 "mypy==1.19.1",
 "pre-commit>=2.17.0,<5.0.0",
 "pytest>=7.0.1,<9.0.0",
 "ruff==0.14.10",
 "typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down

2 changes: 0 additions & 2 deletions
requirements-docs-tests.txt

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Jan 4, 2026
 Merged


⬆️ Migrate to uv
#1688
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e51101a

⬆️ Migrate to uv


DoctorJohn Dec 23, 2025
a7b90b0

Stop installing unneeded deps


DoctorJohn Jan 2, 2026
69e13be

👷 Update .github/workflows/smokeshow.yml


tiangolo Jan 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/dependabot.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
 commit-message:
 prefix: ⬆
 # Python
 - package-ecosystem: "pip"
 - package-ecosystem: "uv"
 directory: "/"
 schedule:
 interval: "daily"
Expand Down

17 changes: 6 additions & 11 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
 - opened
 - synchronize

env:
 UV_SYSTEM_PYTHON: 1


jobs:
 changes:
 runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
 - uses: actions/cache@v5
 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@v6
 with:
 name: docs-site
Expand Down

16 changes: 6 additions & 10 deletions
.github/workflows/deploy-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
 pull-requests: write
 statuses: write

env:
 UV_SYSTEM_PYTHON: 1

jobs:
 deploy-docs:
 runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down

7 changes: 2 additions & 5 deletions
.github/workflows/pre-commit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
 - name: Set up Python
 uses: actions/setup-python@v6
 with:
 python-version: "3.14"
 python-version-file: ".python-version"
 - name: Setup uv
 uses: astral-sh/setup-uv@v7
 with:
 cache-dependency-glob: |
 requirements**.txt
 pyproject.toml
 uv.lock
 - name: Install Dependencies
 run: |
 uv venv
 uv pip install -r requirements.txt
 run: uv sync --locked
 - name: Run prek - pre-commit
 id: precommit
 run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down

15 changes: 10 additions & 5 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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

11 changes: 4 additions & 7 deletions
.github/workflows/smokeshow.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
 - uses: actions/download-artifact@v7
 with:
 name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
 - name: Upload coverage to Smokeshow
 run: |
 for i in 1 2 3 4 5; do
 if smokeshow upload htmlcov; then
 if uv run smokeshow upload htmlcov; then
 echo "Smokeshow upload success!"
 break
 fi
Expand Down

4 changes: 2 additions & 2 deletions
.github/workflows/test-redistribute.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
 - name: Install test dependencies
 run: |
 cd dist/sqlmodel*/
 pip install -r requirements-tests.txt
 pip install --group tests --editable .
 env:
 TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
 - name: Run source distribution tests
Expand Down

24 changes: 12 additions & 12 deletions
.github/workflows/test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
 - cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
 test:
Expand All@@ -42,6 +42,8 @@ jobs:
 python-version: "3.13"
 fail-fast: false
 runs-on: ${{ matrix.os }}
 env:
 UV_PYTHON: ${{ matrix.python-version }}
 steps:
 - uses: actions/checkout@v6
 - name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
 - 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 }}
Expand All@@ -85,33 +86,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@v7
 with:
 pattern: coverage-*
 path: coverage
 merge-multiple: true
 - name: Install Dependencies
 run: uv pip install -r requirements-tests.txt
 run: uv sync --locked --no-dev --group tests
 - 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@v6
 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
Expand Down

1 change: 1 addition & 0 deletions
.python-version

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9

10 changes: 3 additions & 7 deletions
docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down

45 changes: 43 additions & 2 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
 { include-group = "tests" },
 "prek>=0.2.24,<1.0.0",
]
docs = [
 "black>=22.10",
 "cairosvg==2.8.2",
 "griffe-typingdoc==0.3.0",
 "griffe-warnings-deprecated==1.1.0",
 "markdown-include-variants==0.0.8",
 "mdx-include>=1.4.1,<2.0.0",
 "mkdocs-macros-plugin==1.5.0",
 "mkdocs-material==9.7.1",
 "mkdocs-redirects>=1.2.1,<1.3.0",
 "mkdocstrings[python]==0.30.1",
 "pillow==11.3.0",
 "pyyaml>=5.3.1,<7.0.0",
 "typer==0.21.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",
]
tests = [
 "black>=22.10",
 "coverage[toml]>=6.2,<8.0",
 "dirty-equals==0.11",
 "fastapi>=0.103.2,<0.129.0",
 "httpx==0.28.1",
 "jinja2==3.1.6",
 "mypy==1.19.1",
 "pre-commit>=2.17.0,<5.0.0",
 "pytest>=7.0.1,<9.0.0",
 "ruff==0.14.10",
 "typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down

2 changes: 0 additions & 2 deletions
requirements-docs-tests.txt

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Jan 4, 2026
 Merged


⬆️ Migrate to uv
#1688
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e51101a

⬆️ Migrate to uv


DoctorJohn Dec 23, 2025
a7b90b0

Stop installing unneeded deps


DoctorJohn Jan 2, 2026
69e13be

👷 Update .github/workflows/smokeshow.yml


tiangolo Jan 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/dependabot.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
 commit-message:
 prefix: ⬆
 # Python
 - package-ecosystem: "pip"
 - package-ecosystem: "uv"
 directory: "/"
 schedule:
 interval: "daily"
Expand Down

17 changes: 6 additions & 11 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
 - opened
 - synchronize

env:
 UV_SYSTEM_PYTHON: 1


jobs:
 changes:
 runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
 - uses: actions/cache@v5
 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@v6
 with:
 name: docs-site
Expand Down

16 changes: 6 additions & 10 deletions
.github/workflows/deploy-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
 pull-requests: write
 statuses: write

env:
 UV_SYSTEM_PYTHON: 1

jobs:
 deploy-docs:
 runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down

7 changes: 2 additions & 5 deletions
.github/workflows/pre-commit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
 - name: Set up Python
 uses: actions/setup-python@v6
 with:
 python-version: "3.14"
 python-version-file: ".python-version"
 - name: Setup uv
 uses: astral-sh/setup-uv@v7
 with:
 cache-dependency-glob: |
 requirements**.txt
 pyproject.toml
 uv.lock
 - name: Install Dependencies
 run: |
 uv venv
 uv pip install -r requirements.txt
 run: uv sync --locked
 - name: Run prek - pre-commit
 id: precommit
 run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down

15 changes: 10 additions & 5 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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

11 changes: 4 additions & 7 deletions
.github/workflows/smokeshow.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
 - uses: actions/download-artifact@v7
 with:
 name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
 - name: Upload coverage to Smokeshow
 run: |
 for i in 1 2 3 4 5; do
 if smokeshow upload htmlcov; then
 if uv run smokeshow upload htmlcov; then
 echo "Smokeshow upload success!"
 break
 fi
Expand Down

4 changes: 2 additions & 2 deletions
.github/workflows/test-redistribute.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
 - name: Install test dependencies
 run: |
 cd dist/sqlmodel*/
 pip install -r requirements-tests.txt
 pip install --group tests --editable .
 env:
 TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
 - name: Run source distribution tests
Expand Down

24 changes: 12 additions & 12 deletions
.github/workflows/test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
 - cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
 test:
Expand All@@ -42,6 +42,8 @@ jobs:
 python-version: "3.13"
 fail-fast: false
 runs-on: ${{ matrix.os }}
 env:
 UV_PYTHON: ${{ matrix.python-version }}
 steps:
 - uses: actions/checkout@v6
 - name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
 - 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 }}
Expand All@@ -85,33 +86,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@v7
 with:
 pattern: coverage-*
 path: coverage
 merge-multiple: true
 - name: Install Dependencies
 run: uv pip install -r requirements-tests.txt
 run: uv sync --locked --no-dev --group tests
 - 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@v6
 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
Expand Down

1 change: 1 addition & 0 deletions
.python-version

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9

10 changes: 3 additions & 7 deletions
docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down

45 changes: 43 additions & 2 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
 { include-group = "tests" },
 "prek>=0.2.24,<1.0.0",
]
docs = [
 "black>=22.10",
 "cairosvg==2.8.2",
 "griffe-typingdoc==0.3.0",
 "griffe-warnings-deprecated==1.1.0",
 "markdown-include-variants==0.0.8",
 "mdx-include>=1.4.1,<2.0.0",
 "mkdocs-macros-plugin==1.5.0",
 "mkdocs-material==9.7.1",
 "mkdocs-redirects>=1.2.1,<1.3.0",
 "mkdocstrings[python]==0.30.1",
 "pillow==11.3.0",
 "pyyaml>=5.3.1,<7.0.0",
 "typer==0.21.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",
]
tests = [
 "black>=22.10",
 "coverage[toml]>=6.2,<8.0",
 "dirty-equals==0.11",
 "fastapi>=0.103.2,<0.129.0",
 "httpx==0.28.1",
 "jinja2==3.1.6",
 "mypy==1.19.1",
 "pre-commit>=2.17.0,<5.0.0",
 "pytest>=7.0.1,<9.0.0",
 "ruff==0.14.10",
 "typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down

2 changes: 0 additions & 2 deletions
requirements-docs-tests.txt

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
⬆️ Migrate to uv#1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Jan 4, 2026
 Merged


⬆️ Migrate to uv
#1688
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e51101a

⬆️ Migrate to uv


DoctorJohn Dec 23, 2025
a7b90b0

Stop installing unneeded deps


DoctorJohn Jan 2, 2026
69e13be

👷 Update .github/workflows/smokeshow.yml


tiangolo Jan 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/dependabot.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ updates:
 commit-message:
 prefix: ⬆
 # Python
 - package-ecosystem: "pip"
 - package-ecosystem: "uv"
 directory: "/"
 schedule:
 interval: "daily"
Expand Down

17 changes: 6 additions & 11 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,6 @@ on:
 - opened
 - synchronize

env:
 UV_SYSTEM_PYTHON: 1


jobs:
 changes:
 runs-on: ubuntu-latest
Expand All@@ -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
Expand All@@ -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 --no-dev --group docs
 - uses: actions/cache@v5
 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@v6
 with:
 name: docs-site
Expand Down

16 changes: 6 additions & 10 deletions
.github/workflows/deploy-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,6 @@ permissions:
 pull-requests: write
 statuses: write

env:
 UV_SYSTEM_PYTHON: 1

jobs:
 deploy-docs:
 runs-on: ubuntu-latest
Expand All@@ -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 --no-dev --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 }}
Expand DownExpand Up@@ -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 }}
Expand Down

7 changes: 2 additions & 5 deletions
.github/workflows/pre-commit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,18 +40,15 @@ jobs:
 - name: Set up Python
 uses: actions/setup-python@v6
 with:
 python-version: "3.14"
 python-version-file: ".python-version"
 - name: Setup uv
 uses: astral-sh/setup-uv@v7
 with:
 cache-dependency-glob: |
 requirements**.txt
 pyproject.toml
 uv.lock
 - name: Install Dependencies
 run: |
 uv venv
 uv pip install -r requirements.txt
 run: uv sync --locked
 - name: Run prek - pre-commit
 id: precommit
 run: uvx prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
Expand Down

15 changes: 10 additions & 5 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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

11 changes: 4 additions & 7 deletions
.github/workflows/smokeshow.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 --no-dev --group github-actions
 - uses: actions/download-artifact@v7
 with:
 name: coverage-html
Expand All@@ -36,7 +33,7 @@ jobs:
 - name: Upload coverage to Smokeshow
 run: |
 for i in 1 2 3 4 5; do
 if smokeshow upload htmlcov; then
 if uv run smokeshow upload htmlcov; then
 echo "Smokeshow upload success!"
 break
 fi
Expand Down

4 changes: 2 additions & 2 deletions
.github/workflows/test-redistribute.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -40,7 +40,7 @@ jobs:
 - name: Install test dependencies
 run: |
 cd dist/sqlmodel*/
 pip install -r requirements-tests.txt
 pip install --group tests --editable .
 env:
 TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
 - name: Run source distribution tests
Expand Down

24 changes: 12 additions & 12 deletions
.github/workflows/test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ on:
 - cron: "0 0 * * 1"

env:
UV_SYSTEM_PYTHON: 1
UV_NO_SYNC: true

jobs:
 test:
Expand All@@ -42,6 +42,8 @@ jobs:
 python-version: "3.13"
 fail-fast: false
 runs-on: ${{ matrix.os }}
 env:
 UV_PYTHON: ${{ matrix.python-version }}
 steps:
 - uses: actions/checkout@v6
 - name: Set up Python
Expand All@@ -51,22 +53,21 @@ 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 --no-dev --group tests
 - 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 }}
Expand All@@ -85,33 +86,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@v7
 with:
 pattern: coverage-*
 path: coverage
 merge-multiple: true
 - name: Install Dependencies
 run: uv pip install -r requirements-tests.txt
 run: uv sync --locked --no-dev --group tests
 - 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@v6
 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
Expand Down

1 change: 1 addition & 0 deletions
.python-version

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
3.9

10 changes: 3 additions & 7 deletions
docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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%
```
Expand Down

45 changes: 43 additions & 2 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,48 @@ 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" },
 { include-group = "tests" },
 "prek>=0.2.24,<1.0.0",
]
docs = [
 "black>=22.10",
 "cairosvg==2.8.2",
 "griffe-typingdoc==0.3.0",
 "griffe-warnings-deprecated==1.1.0",
 "markdown-include-variants==0.0.8",
 "mdx-include>=1.4.1,<2.0.0",
 "mkdocs-macros-plugin==1.5.0",
 "mkdocs-material==9.7.1",
 "mkdocs-redirects>=1.2.1,<1.3.0",
 "mkdocstrings[python]==0.30.1",
 "pillow==11.3.0",
 "pyyaml>=5.3.1,<7.0.0",
 "typer==0.21.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",
]
tests = [
 "black>=22.10",
 "coverage[toml]>=6.2,<8.0",
 "dirty-equals==0.11",
 "fastapi>=0.103.2,<0.129.0",
 "httpx==0.28.1",
 "jinja2==3.1.6",
 "mypy==1.19.1",
 "pre-commit>=2.17.0,<5.0.0",
 "pytest>=7.0.1,<9.0.0",
 "ruff==0.14.10",
 "typing-extensions==4.15.0",
]

[tool.pdm]
version = { source = "file", path = "sqlmodel/__init__.py" }
distribution = true
Expand All@@ -55,10 +97,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"
Expand Down

2 changes: 0 additions & 2 deletions
requirements-docs-tests.txt

View file


Open in desktop


This file was deleted.

Loading