Working uv + Ubuntu24 setup

- Tox config in pyproject.toml (run with tox-uv)
- In docker, uv has its own isolated environment (at /.venv)
- Remove old requirements files (use uv.lock)

Author: davidfischer

.github/workflows/ci.yml

@@ -19,7 +19,9 @@ jobs:
           python-version: "3.12"
 
       - name: Install dependencies
-        run: uv sync --frozen --all-extras
+        run: |
+          uv sync --frozen --all-extras
+          uv tool install tox --with tox-uv
 
       - name: Run CI
         run: |

.github/workflows/pip-tools.yaml

@@ -44,7 +44,7 @@ jobs:
             Dependencies: all packages updated via uv lock
           body: |
             Dependencies: all packages updated via uv lock
-            
+
             This PR updates the `uv.lock` file with the latest compatible versions
             of all dependencies specified in `pyproject.toml`.
           commit-message: |

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
   - id: trailing-whitespace
     exclude: '.*/dnt-policy.txt$'
 - repo: https://github.com/adamchainz/django-upgrade
-  rev: "1.14.1"
+  rev: "1.29.1"
   hooks:
   - id: django-upgrade
     args: [--target-version, "5.2"]

Makefile

@@ -18,6 +18,8 @@ help:
 	@echo "  geoip          Download the GeoIP databases"
 	@echo "  ipproxy        Download proxy databases"
 
+# Run the full test suite
+# Run a specific test with tox -e py3 -- adserver/auth/tests.py
 test:
 	tox
 
@@ -46,11 +48,11 @@ dockerstop:
 # Use this command to inspect the container, run management commands,
 # or run anything else on the Django container
 dockershell:
-	docker compose -f $(DOCKER_CONFIG) run --rm django /bin/bash
+	docker compose -f $(DOCKER_CONFIG) run --rm django /shell
 
 # Get the GeoIP databases from DB-IP or Maxmind
 geoip:
-	python $(GEOIP_DOWNLOADER) --geoip-only --outdir=$(GEOIP_DIR)
+	uv run python $(GEOIP_DOWNLOADER) --geoip-only --outdir=$(GEOIP_DIR)
 
 ipproxy:
-	python $(GEOIP_DOWNLOADER) --ipproxy-only --outdir=$(GEOIP_DIR)
+	uv run python $(GEOIP_DOWNLOADER) --ipproxy-only --outdir=$(GEOIP_DIR)

docker-compose/django/Dockerfile

@@ -6,6 +6,17 @@ ENV LANGUAGE en_US:en
 ENV LC_ALL en_US.UTF-8
 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
+
+# Pep668 prevents pip from modifying system packages
+# https://peps.python.org/pep-0668/
+ENV PIP_BREAK_SYSTEM_PACKAGES=1
+
 RUN apt-get -y update
 RUN apt-get -y install \
         curl \
@@ -23,45 +34,47 @@ RUN apt-get -y install \
         libmysqlclient-dev \
         libfreetype6 \
         libjpeg-dev \
-        sqlite \
+        sqlite3 \
         netcat-openbsd \
         telnet \
         lsb-release
 
 # Install uv for fast package management
-RUN curl -LsSf https://astral.sh/uv/install.sh | sh
-ENV PATH="/root/.cargo/bin:${PATH}"
+# https://docs.astral.sh/uv/guides/integration/docker/#installing-uv
+ADD https://astral.sh/uv/install.sh /uv-installer.sh
+RUN sh /uv-installer.sh && rm /uv-installer.sh
+ENV PATH="/root/.local/bin/:$PATH"
 
 # Copy project files for dependency resolution
 # uv.lock ensures reproducible builds
 COPY pyproject.toml uv.lock ./
 
 # Install dependencies using uv sync
+# This creates a virtual environment at /.venv (not in /app)
 # This installs all dependencies from uv.lock, ensuring consistency
 # --frozen: Don't update the lockfile
-# --no-install-project: Don't install the project itself (we'll copy source later)
-# By default, installs base dependencies + dev group (for development container)
+# --no-install-project: Don't install the project itself
+# If you do not want the analyzer dependencies (which are LARGE), you can use:
+#  RUN --mount=type=cache,target=/root/.cache/uv \
+#      uv sync --frozen --no-install-project --extra dev --extra production
 RUN --mount=type=cache,target=/root/.cache/uv \
     uv sync --frozen --no-install-project --all-extras
 
-# For production builds, you can use:
-# RUN --mount=type=cache,target=/root/.cache/uv \
-#     uv sync --frozen --no-install-project --no-dev --extra production --extra analyzer
-
 COPY ./docker-compose/django/start /start
 RUN chmod +x /start
 
+# Launch a shell within the container with this script
+COPY ./docker-compose/django/shell /shell
+RUN chmod +x /shell
+
 COPY ./docker-compose/django/celery/worker/start /start-celeryworker
 RUN chmod +x /start-celeryworker
 
 COPY ./docker-compose/django/celery/beat/start /start-celerybeat
 RUN chmod +x /start-celerybeat
 
-# Ensure that ``python`` is in the PATH so that ``./manage.py`` works
-RUN ln -s /usr/bin/python3 /usr/bin/python
-
 # Load model
-RUN python -c "from sentence_transformers import SentenceTransformer; SentenceTransformer('multi-qa-MiniLM-L6-cos-v1', cache_folder='/tmp/sentence_transformers')"
+RUN uv run python -c "from sentence_transformers import SentenceTransformer; SentenceTransformer('multi-qa-MiniLM-L6-cos-v1', cache_folder='/tmp/sentence_transformers')"
 
 # Setup the locale
 RUN locale-gen en_US.UTF-8

docker-compose/django/celery/beat/start

@@ -5,4 +5,4 @@ set -o nounset
 
 
 rm -f './celerybeat.pid'
-celery -A config.celery_app beat -l INFO
+uv run celery -A config.celery_app beat -l INFO

docker-compose/django/celery/worker/start

@@ -4,4 +4,4 @@ set -o errexit
 set -o nounset
 
 
-celery -A config.celery_app worker -l INFO -Q celery,analyzer,priority -c 1
+uv run celery -A config.celery_app worker -l INFO -Q celery,analyzer,priority -c 1

docker-compose/django/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-compose/django/start

@@ -4,12 +4,13 @@ set -o errexit
 set -o pipefail
 set -o nounset
 
+
 # Reinstall dependencies without rebuilding docker image
 # pip install -r /app/requirements/development.txt
 
 # Don't auto-migrate locally because this can cause weird issues when testing migrations
 # python manage.py migrate
-python manage.py runserver 0.0.0.0:5000
+uv run ./manage.py runserver 0.0.0.0:5000
 
 # In production, we use gunicorn
 # This gets us close to that setting for development and testing

docs/developer/quickstart.rst

@@ -44,7 +44,7 @@ Requirements
 ~~~~~~~~~~~~
 
 - Python 3.12
-- Nodejs (tested with v14)
+- Nodejs (tested with v20)
 
 Front-end assets
 ~~~~~~~~~~~~~~~~
@@ -67,8 +67,8 @@ Then install dependencies:
 
 .. code-block:: bash
 
-   $ uv sync --all-extras         # Install all dependencies including dev tools
-   $ pre-commit install            # Install a code style pre-commit hook
+   $ uv sync --all-extras           # Install all dependencies including dev tools
+   $ uv run pre-commit install      # Install a code style pre-commit hook
 
 Run the server
 ~~~~~~~~~~~~~~
@@ -77,19 +77,19 @@ Run migrations:
 
 .. code-block:: bash
 
-   $ uv run python manage.py migrate
+   $ uv run ./manage.py migrate
 
 Create a superuser:
 
 .. code-block:: bash
 
-   $ uv run python manage.py createsuperuser
+   $ uv run ./manage.py createsuperuser
 
 Run the server:
 
 .. code-block:: bash
 
-   $ uv run python manage.py runserver
+   $ uv run ./manage.py runserver
 
 Running the tests
 -----------------
@@ -98,8 +98,8 @@ To run the unit tests:
 
 .. code-block:: bash
 
-    $ uv sync --all-extras  # If not already installed
-    $ make test
+    $ uv tool install tox --with tox-uv
+    $ tox
 
 Run a specific test: