Add uv support for local development, CI, and Docker (#748)

Author: Srishti-j18

.github/workflows/ci.yml

@@ -13,12 +13,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v4
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
+          version: '0.11.16'
           python-version: '3.12'
-          cache: 'pip'
-          cache-dependency-path: 'requirements/*.txt'
-      - run: pip install -r requirements/development.txt
+          enable-cache: true
+      - run: uv venv .venv
+      - run: echo "$GITHUB_WORKSPACE/.venv/bin" >> "$GITHUB_PATH"
+      - run: uv pip install --python .venv/bin/python -r requirements/development.txt
       - run: make lint-server
   lint-client:
     runs-on: ubuntu-latest
@@ -36,12 +38,14 @@ jobs:
       DJANGO_SETTINGS_MODULE: bakerydemo.settings.test
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v4
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
+          version: '0.11.16'
           python-version: '3.12'
-          cache: 'pip'
-          cache-dependency-path: 'requirements/*.txt'
-      - run: pip install -r requirements/development.txt
+          enable-cache: true
+      - run: uv venv .venv
+      - run: echo "$GITHUB_WORKSPACE/.venv/bin" >> "$GITHUB_PATH"
+      - run: uv pip install --python .venv/bin/python -r requirements/development.txt
       - run: ./manage.py check
       - run: ./manage.py makemigrations --check --noinput
       - run: ./manage.py test

Dockerfile

@@ -1,6 +1,11 @@
+ARG UV_VERSION=0.11.16
+FROM ghcr.io/astral-sh/uv:${UV_VERSION} AS uv
+
 FROM python:3.12-slim
 ARG NIGHTLY=0
 
+COPY --from=uv /uv /uvx /bin/
+
 # Install packages needed to run your application (not build deps):
 # We need to recreate the /usr/share/man/man{1..8} directories first because
 # they were clobbered by a parent image.
@@ -39,9 +44,8 @@ RUN set -ex \
             grep -o 'https://[^"]*') \
         && sed -i "s|wagtail>=.*|${NIGHTLY_URL}|" /requirements/base.txt; \
     fi \
-    && python3.12 -m venv ${VIRTUAL_ENV} \
-    && python3.12 -m pip install -U pip \
-    && python3.12 -m pip install --no-cache-dir -r /requirements/production.txt \
+    && uv venv ${VIRTUAL_ENV} \
+    && uv pip install --python ${VIRTUAL_ENV}/bin/python -r /requirements/production.txt \
     && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false $BUILD_DEPS \
     && rm -rf /var/lib/apt/lists/*
 

readme.md

@@ -31,6 +31,7 @@ This demo is aimed primarily at developers wanting to learn more about the inter
 # Installation
 
 - [Venv](#setup-with-venv)
+- [uv](#setup-with-uv)
 - [Vagrant](#setup-with-vagrant)
 - [Docker](#setup-with-docker)
 
@@ -141,7 +142,7 @@ On Windows, activate the virtual environment using the appropriate command for y
 > - allow scripts in PowerShell for your user account:
 >   `Set-ExecutionPolicy -Scope CurrentUser RemoteSigned`
 
-Now we're ready to set up the bakery demo project itself:
+Now we're ready to set up the bakerydemo project itself:
 ```bash
 cd ~/dev [or your preferred dev directory]
 git clone https://github.com/wagtail/bakerydemo.git
@@ -165,6 +166,64 @@ To set up your database and load initial data, run the following commands:
 
 Log into the admin with the credentials `admin / changeme`.
 
+## Setup with uv
+
+If you prefer [uv](https://docs.astral.sh/uv/), bakerydemo also supports the existing requirements-based workflow with uv-managed environments. This is optional and is intended as an additional local development path alongside manual `venv` usage.
+
+#### Dependencies
+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
+
+Install `uv` using one of the methods from the official installation guide.
+For example, on macOS and Linux:
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### Installation
+
+Now we're ready to set up the bakerydemo project itself:
+
+```bash
+cd ~/dev [or your preferred dev directory]
+git clone https://github.com/wagtail/bakerydemo.git
+cd bakerydemo
+```
+
+Create and activate a virtual environment with uv:
+
+On macOS / GNU/Linux:
+```bash
+uv venv .venv
+source .venv/bin/activate
+```
+
+On Windows, activate the virtual environment using the appropriate command for your shell:
+
+```bash
+# PowerShell
+.venv\Scripts\Activate.ps1
+# Command Prompt (cmd.exe)
+.venv\Scripts\activate.bat
+```
+
+Install the development dependencies:
+
+```bash
+uv pip install -r requirements/development.txt
+```
+
+Then continue with the same local configuration and database setup steps as in the `venv` instructions above:
+
+```bash
+cp bakerydemo/settings/local.py.example bakerydemo/settings/local.py
+cp .env.example .env
+./manage.py migrate
+./manage.py load_initial_data
+./manage.py runserver
+```
+
 # Next steps
 
 After experimenting with the demo, you may want to create your own site. To do that, run the `wagtail start` command in your environment of choice. You can find more information in the [getting started Wagtail CMS docs](https://docs.wagtail.org/en/stable/getting_started/index.html).