Merge pull request #194 from sandiegopython/davidfischer/use-uv-ruff

Switch to uv/ruff setup

Author: davidfischer

.github/workflows/ci.yml

@@ -11,16 +11,26 @@ on:
 jobs:
   build:
 
-    name: Unit tests and code checks
+    name: Unit tests and code style checks
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v5
+
+      # https://docs.astral.sh/uv/guides/integration/github/
+      - uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - uses: actions/setup-python@v6
         with:
-          python-version: "3.14"
+          python-version-file: "pyproject.toml"
+
+      - name: Install dependencies
+        run: |
+          uv sync --frozen --extra dev
+          uv tool install tox --with tox-uv
 
       - name: Run CI
         run: |
-          pip install "tox>=4.0,<5.0"
           tox

.pre-commit-config.yaml

@@ -1,15 +1,27 @@
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v6.0.0
-    hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 25.9.0
-    hooks:
-    - id: black
-      # Since the pre-commit runs on a file by file basis rather than a whole project,
-      # The excludes in pyproject.toml are ignored
-      exclude: migrations
-      language_version: python3.14
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-yaml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/adamchainz/django-upgrade
+  rev: "1.29.1"
+  hooks:
+  - id: django-upgrade
+    args: [--target-version, "5.2"]
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.6
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+- repo: https://github.com/astral-sh/uv-pre-commit
+  # uv version.
+  rev: 0.9.11
+  hooks:
+    # Compile requirements to ensure uv.lock is up-to-date
+    - id: uv-lock

Dockerfile

@@ -9,6 +9,13 @@ LABEL maintainer="https://github.com/sandiegopython"
 ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONUNBUFFERED 1
 
+# uv environment variables
+# Copy (don't hardlink) files into /.venv. Avoid issues with Docker's FS
+# https://docs.astral.sh/uv/reference/environment/
+ENV UV_LINK_MODE=copy
+ENV UV_PYTHON_DOWNLOADS=never
+ENV UV_PROJECT_ENVIRONMENT=/.venv
+
 RUN apt-get update
 RUN apt-get install -y --no-install-recommends curl
 
@@ -25,28 +32,40 @@ RUN apt-get install -y --no-install-recommends \
     postgresql-client libpq-dev \
     git
 
-RUN mkdir -p /code
-
+RUN mkdir -p /code /home/www/
 WORKDIR /code
 
-# Requirements are installed here to ensure they will be cached.
-# https://docs.docker.com/build/cache/#use-the-dedicated-run-cache
-COPY ./requirements /requirements
-RUN pip install --upgrade pip
-RUN --mount=type=cache,target=/root/.cache/pip pip install -r /requirements/deployment.txt
-RUN --mount=type=cache,target=/root/.cache/pip pip install -r /requirements/local.txt
+# Install uv for fast package management
+# https://docs.astral.sh/uv/guides/integration/docker/#installing-uv
+COPY --from=ghcr.io/astral-sh/uv:0.9.11 /uv /uvx /bin/
+
+# Copy project files for dependency resolution
+# uv.lock ensures reproducible builds
+COPY pyproject.toml uv.lock ./
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-install-project --all-extras
 
 COPY . /code/
 
 # Build JS/static assets
 RUN --mount=type=cache,target=/root/.npm npm install
 RUN npm run dist
 
-RUN python manage.py collectstatic --noinput --clear
+RUN uv run python manage.py collectstatic --noinput --clear
+
+# Launches the application (gunicorn) with this script
+COPY ./docker/start /start
+RUN chmod +x /start
+
+# Launch a shell within the container with this script
+COPY ./docker/shell /shell
+RUN chmod +x /shell
 
 # Run the container unprivileged
 RUN addgroup www && useradd -g www www
 RUN chown -R www:www /code
+# Needed for the uv cache
+RUN chown -R www:www /home/www
 USER www
 
 # Output information about the build
@@ -56,4 +75,4 @@ RUN date -u +'%Y-%m-%dT%H:%M:%SZ' > BUILD_DATE
 
 EXPOSE 8000
 
-CMD ["gunicorn", "--timeout", "15", "--bind", ":8000", "--workers", "2", "--max-requests", "10000", "--max-requests-jitter", "100", "--log-file", "-", "--access-logfile", "-", "config.wsgi"]
+CMD ["/start"]

Makefile

@@ -35,7 +35,7 @@ dockerserve:
 # or run anything else on the Django container. It does expect the
 # container to already be running
 dockershell:
-	docker compose -f $(DOCKER_CONFIG) exec django /bin/bash
+	docker compose -f $(DOCKER_CONFIG) run --rm django /shell
 
 # Build and deploy the production container
 deploy:

README.md

@@ -7,19 +7,28 @@ This is the repository for the San Diego Python website at [sandiegopython.org](
 
 ### Prerequisites
 
-* Python v3.14
+* [uv](https://docs.astral.sh) (see [uv installation](https://docs.astral.sh/uv/getting-started/installation/))
 * Node v20
 
+
 ### Getting started
 
+Install Python 3.14 with uv:
+
+```shell
+uv python install
+```
+
+Install dependencies and dev setup
+
 ```shell
-pip install -r requirements/local.txt  # Install local Python requirements
-npm install                            # Install JS dependencies for frontend CSS/JS
-npm run build                          # Build CSS (continuously with `npm run watch`)
-pre-commit install                     # Setup code standard pre-commit hook
-./manage.py migrate                    # Create a local development database
-./manage.py createsuperuser            # Create a local development administrator user
-./manage.py runserver                  # Starts a local development server at http://localhost:8000
+uv sync --all-extras                    # Install local Python requirements
+npm install                             # Install JS dependencies for frontend CSS/JS
+npm run build                           # Build CSS (continuously with `npm run watch`)
+uv run pre-commit install               # Setup code standard pre-commit hook
+uv run ./manage.py migrate              # Create a local development database
+uv run ./manage.py createsuperuser      # Create a local development administrator user
+uv run ./manage.py runserver            # Starts a local development server at http://localhost:8000
 ```
 
 
@@ -28,6 +37,7 @@ pre-commit install                     # Setup code standard pre-commit hook
 The entire test suite can be run with tox:
 
 ```shell
+uv tool install tox --with tox-uv       # Install tox-uv (only needs to be run once ever)
 tox
 ```
 

config/settings/base.py

@@ -13,6 +13,7 @@
 
 import dj_database_url
 
+
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../..")
 

config/settings/test.py

@@ -20,6 +20,11 @@
     },
 }
 
+# Disable logging during tests to keep the output clean
+for logger in LOGGING["loggers"].values():
+    logger["handlers"] = ["null"]
+    logger["level"] = "CRITICAL"
+
 
 # Ignore whitenoise message about no static directory
 warnings.filterwarnings("ignore", message="No directory at", module="whitenoise.base")

config/urls.py

@@ -1,8 +1,8 @@
 from django.conf import settings
+from django.conf.urls.static import static
 from django.contrib import admin
 from django.urls import include
 from django.urls import path
-from django.conf.urls.static import static
 
 
 urlpatterns = [

docker/shell

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+
+# Use the venv created by `uv sync` in the Dockerfile
+source /.venv/bin/activate
+
+# Start shell with the venv activated
+/bin/bash

docker/start

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+
+# Launch gunicorn - the production web server
+# https://docs.gunicorn.org/en/stable/settings.html
+uv run gunicorn \
+    --timeout 15 \
+    --bind :8000 \
+    --workers 2 \
+    --max-requests 10000 \
+    --max-requests-jitter 100 \
+    --log-file - \
+    --access-logfile - \
+    config.wsgi