Migrated to use pyproject.toml and uv

Also removed the `test-results` job (added in b833efd)
as it's not needed now that we don't use `strategy.matrix` anymore to
run the tests.

Also changed Dependabot's update schedule for our Python dependencies
from daily to weekly, which is probably more manageable for us.

Also upgraded `actions/checkout` and `actions/setup-python`, which
didn't have any breaking changes for us.

Author: ddabble

.github/dependabot.yml

@@ -1,17 +1,16 @@
 version: 2
 updates:
-  - package-ecosystem: "pip"
+  - package-ecosystem: "uv"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
     target-branch: "main"
     commit-message:
       prefix: "⬆"
       include: "scope"
 
   - package-ecosystem: "github-actions"
-    # Workflow files stored in the
-    # default location of `.github/workflows`
+    # Workflow files stored in the default location of `.github/workflows`
     directory: "/"
     schedule:
       interval: "weekly"

.github/workflows/ci.yml

@@ -4,58 +4,46 @@ on: [ push, pull_request ]
 
 jobs:
   test:
-    name: Python ${{ matrix.python-version }}
+    name: Tests
     runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [ "3.10", "3.11" ]
 
+    # Code based on https://docs.astral.sh/uv/guides/integration/github/
     steps:
-      - uses: actions/checkout@v4
+      - name: Check out Git repository
+        uses: actions/checkout@v5
 
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
         with:
-          python-version: ${{ matrix.python-version }}
-          cache: "pip"
-          cache-dependency-path: "requirements*.txt"
+          python-version-file: "pyproject.toml"
 
       - name: Install System Dependencies
-        # Retries installing files 3 times, as the GitHub Actions CI is occasionally unreliable
+        # Retries installing files 3 times, as either the GitHub Actions runner or APT's API can be unreliable
         run: |
           sudo apt update
           sudo apt install python3-dev libldap2-dev libsasl2-dev libssl-dev -o Acquire::Retries=3
 
-      - name: Install Python Dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r requirements_codecov.txt
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set `UV_PROJECT_ENVIRONMENT` envvar
+        # Install packages into the system environment instead of a `.venv/`.
+        # (`pythonLocation` is from `actions/setup-python` - see
+        # https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#environment-variables)
+        run: echo "UV_PROJECT_ENVIRONMENT=$pythonLocation" >> $GITHUB_ENV
+      - name: Install Python dependencies
+        run: uv sync --locked --group ci
 
       - name: Run Django Tests
         run: |
-          python manage.py collectstatic --no-input
-          coverage run manage.py test
-          coverage xml
+          uv run manage.py collectstatic --no-input
+          uv run coverage run manage.py test
+          uv run coverage xml
 
       - name: Upload to Codecov
         uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml
-
-  # Based on https://github.com/orgs/community/discussions/26822#discussioncomment-5122101
-  test-results:
-    name: Tests passed
-    runs-on: ubuntu-latest
-    needs: [test]
-    if: ${{ always() }}
-
-    steps:
-      - if: >- # Starts a multiline string (see https://stackoverflow.com/a/67532120)
-          ${{
-               contains(needs.*.result, 'failure')
-            || contains(needs.*.result, 'cancelled')
-          }}
-        run: exit 1

CHANGELOG.md

@@ -30,6 +30,8 @@ Lastly, a new [release](https://github.com/MAKENTNU/web/releases) must be create
 - Deleted the `dev` branch; now, the `main` branch will be used as the (sole) default branch, and releases/tags will be used for deployments
   (MAKENTNU/web#758)
 - Prevented `compilemessages` from processing files outside the `src` folder (MAKENTNU/web#766)
+- Migrated project to use the more modern `pyproject.toml` and [uv](https://docs.astral.sh/uv/) instead of `requirements.txt` and pip
+  (MAKENTNU/web#766)
 
 
 ## 2025-05-03 (MAKENTNU/web#757)

Dockerfile

@@ -1,8 +1,9 @@
 FROM python:3.11
 ENV PYTHONUNBUFFERED 1
 RUN apt update --fix-missing && apt install -y python3-dev libldap2-dev libsasl2-dev libssl-dev gettext libgettextpo-dev
+RUN python -m pip install --upgrade pip
+RUN pipx install uv
 RUN mkdir /web
 WORKDIR /web
-COPY requirements.txt /web/
-RUN python -m pip install --upgrade pip
-RUN pip install -r requirements.txt
+COPY pyproject.toml uv.lock /web/
+RUN uv sync --locked

Makefile

@@ -1,20 +1,20 @@
 run:
-	python manage.py runserver 0.0.0.0:8000
+	uv run manage.py runserver 0.0.0.0:8000
 
 migrations:
-	python manage.py makemigrations ${A}
+	uv run manage.py makemigrations ${A}
 
 migrate:
-	python manage.py migrate
+	uv run manage.py migrate
 
 superuser:
-	python manage.py createsuperuser
+	uv run manage.py createsuperuser
 
 startapp:
-	python manage.py startapp
+	uv run manage.py startapp
 
 shell:
-	python manage.py shell
+	uv run manage.py shell
 
 test:
-	python manage.py test
+	uv run manage.py test

README.md

@@ -3,23 +3,28 @@
 [![codecov](https://codecov.io/gh/MAKENTNU/web/graph/badge.svg?token=EL6fslS1y2)](https://codecov.io/gh/MAKENTNU/web)
 
 
-## Setup
+## 🛠️ Setup
 
 <details>
 <summary>Click to expand</summary>
 
-### Prerequisites
-
-* [Git](https://git-scm.com/downloads)
-  * Using a [Git GUI](https://git-scm.com/downloads/guis) is highly recommended, as they allow for much easier and faster visualization of the commit
-    structure, and interaction with it, which will help you avoid many common mistakes
-    * [Git Extensions](https://gitextensions.github.io/) is a good choice - though it only runs on Windows, as of time of writing
-* Python **3.10**+ (latest, stable version preferred)
-* Having cloned this repository to your machine
-  * Either press a "Clone repository" button in your Git GUI, or run:
-    ```shell
-    git clone https://github.com/MAKENTNU/web.git
-    ```
+1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/) (a Python package manager)
+1. [Install Git](https://git-scm.com/downloads)
+1. Installing a [Git GUI](https://git-scm.com/downloads/guis) is highly recommended, as they allow for much easier and faster visualization of
+   the commit structure, and interaction with it, which will help you avoid many common mistakes
+   * [Git Extensions](https://gitextensions.github.io/) is an excellent choice, with support for pretty much all Git features you'll ever use - though
+     it only runs on Windows, as of time of writing
+   * [GitHub Desktop](https://github.com/apps/desktop) works well, but has very limited functionality
+1. Clone this repository to your machine
+   * Either press a "Clone repository" button in your Git GUI, or run:
+     ```shell
+     git clone https://github.com/MAKENTNU/web.git
+     ```
+1. Install dev dependencies:
+   (this will create a `.venv` folder inside your repository folder, by default)
+   ```shell
+   uv sync --group dev
+   ```
 
 #### PyCharm
 
@@ -28,66 +33,25 @@ and because it's able to integrate all the IntelliJ-specific settings in [the pr
 
 If you decide to use this IDE, open the repo folder cloned as part of the prerequisites, through PyCharm (File → Open...),
 and set the following settings (File → Settings...):
-* Under "**Languages & Frameworks**" → "Django":
+* Under "**Python**" → "Django":
   * Make sure the "Enable Django Support" checkbox is checked
   * "Django project root:" `<repo folder location>/src`
   * "Settings:" `web/settings.py`
   * "Manage script:" `<repo folder location>/manage.py`
-* Under "**Project: \<repo folder name\>**" → "Project Structure":
+* Under "**Project Structure**":
   * Mark the `src` folder as "Sources"
+* Follow [these instructions](https://www.jetbrains.com/help/pycharm/configuring-python-interpreter.html#-r16mz0_87)
+  to add the _existing_ uv environment that you created inside the `.venv` folder
 
-### Installation
-
-1. Create a virtual environment, presumably named `venv`:
-   * This should be placed in the folder *containing* the project folder, and not inside the project folder itself
-     * Example folder structure (where `web` is the name of the project folder):
-       ```
-       MAKE
-       ├─ venv
-       └─ web
-          └─ README.md (this file)
-       ```
-     * Among other things, this prevents translations from being made inside the virtual environment folder
-       when running the `makemessages` management command
-     * If using PyCharm, and a virtual environment was not created as part of the project creation process, refer to
-       [the "Configure a virtual environment" guide](https://www.jetbrains.com/help/pycharm/creating-virtual-environment.html#python_create_virtual_env)
-     * Otherwise, `cd` to the project folder, and run:
-       ```shell
-       [newest installed Python command, like python3.11] -m venv ../venv
-       ```
-1. Activate the virtual environment:
-   * If using PyCharm, this should be done automatically when opening a terminal tab inside the IDE
-   * Otherwise, `cd` to the project folder, and run:
-     * On Windows:
-       ```shell
-       ..\venv\Scripts\activate
-       ```
-     * On Linux/macOS:
-       ```shell
-       source ../venv/bin/activate
-       ```
-1. Install requirements:
-   * If using Windows, first download the correct wheel for the [`python-ldap`](https://pypi.org/project/python-ldap/) package
-     from [Christoph Gohlke](https://github.com/cgohlke)'s [python-ldap-build repository](https://github.com/cgohlke/python-ldap-build).
-     and install it:
-     ```shell
-     pip install [path to .whl file]
-     ```
-     (It is possible to instead build `python-ldap` from source, but it's a bit cumbersome setting up the right build tools.)
-   * Regardless of operating system, run:
-     ```shell
-     pip install -r requirements.txt
-     ```
-
-### Running the server for the first time
+### 🚀 Starting the webserver
 
 1. Create an SQLite database file with the proper tables:
    ```shell
-   python manage.py migrate
+   uv run manage.py migrate
    ```
 1. Create an admin user for local development:
    ```shell
-   python manage.py createsuperuser
+   uv run manage.py createsuperuser
    ```
    It's easiest to create one with both the username and the password set to "admin", and with no email address.
 1. Run the server:
@@ -96,23 +60,31 @@ and set the following settings (File → Settings...):
        which by default should be named "web" and have a tiny Django logo
    * Otherwise, run:
      ```shell
-     python manage.py runserver [optional port number; defaults to 8000]
+     uv run manage.py runserver
      ```
+
+### 🧳 Developing offline
+
+When running uv commands, pass [the `--offline` flag](https://docs.astral.sh/uv/reference/cli/#uv-run--offline).
+For example:
+```shell
+uv run --offline manage.py runserver
+```
 </details>
 
 
-## Contribution guidelines
+## 🧑‍💻 Contribution guidelines
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for the following topics:
 * [Code style guides](CONTRIBUTING.md#code-style-guides)
 * [Code review guideline: Code smells](CONTRIBUTING.md#code-review-guideline-code-smells)
 
 
-## [Wiki](https://github.com/MAKENTNU/web/wiki)
+## 📖 [Wiki](https://github.com/MAKENTNU/web/wiki)
 [Visit the wiki](https://github.com/MAKENTNU/web/wiki) to read about various things related to development of this project!
 
 
-## Changelog
+## 📝 Changelog
 
 [View the changelog](CHANGELOG.md) to see a list of changes made to the website over time,
 as well as a superficial description of the release process.

docker-compose.yml

@@ -4,8 +4,8 @@ services:
   web:
     build: .
     command: >
-      bash -c "python manage.py migrate
-      && python manage.py runserver 0.0.0.0:8000"
+      bash -c "uv run manage.py migrate
+      && uv run manage.py runserver 0.0.0.0:8000"
     volumes:
       - ./:/web
     ports:

pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+name = "web"
+requires-python = "==3.11.*"
+
+classifiers = [
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+]
+dynamic = [ "version" ]
+
+dependencies = [
+  # Django-related packages
+  "Django==5.0.2",
+  "django-hosts==6.0",
+  "django-ckeditor==6.7.0",
+  "django-cleanup==8.1.0",
+  "django-constance==3.1.0",
+  "django-decorator-include==3.0",
+  # (See this page for a list of all management commands:
+  # https://django-extensions.readthedocs.io/en/latest/command_extensions.html)
+  "django-extensions==3.2.3",
+  "django-ical==1.9.2",
+  "django-multiselectfield==0.1.12",
+  "django-phonenumber-field[phonenumbers]==7.3.0",
+  "django-simple-history==3.5.0",
+  "sorl-thumbnail==12.10.0",
+
+  # Packages related to authentication and other "social" stuff
+  "social-auth-app-django==5.4.1",
+  # This is already a requirement of `social-auth-app-django`, but it's listed here
+  # to provide the `openidconnect` extra - see
+  # https://python-social-auth.readthedocs.io/en/stable/installing.html#using-the-extras-options
+  "social-auth-core[openidconnect]==4.4.2",
+  "python-ldap==3.4.4",
+
+  # Async-related packages (mainly for sending of emails)
+  "channels[daphne]==4.1.0",
+  "channels-redis==4.2.0",
+
+  # Misc. packages
+  "bleach[css]==6.1.0",
+  "Pillow==11.3.0",
+  "uuid==1.30",
+  "XlsxWriter==3.2.0",
+]
+
+[dependency-groups]
+dev = [
+  "django-debug-toolbar==6.0.0",
+]
+ci = [
+  "coverage==7.10.6",
+]
+
+[tool.uv]
+# Don't install `dev` by default (see
+# https://docs.astral.sh/uv/concepts/projects/dependencies/#default-groups), to make it
+# easier to *not* install those dependencies in prod
+default-groups = [  ]
+
+[tool.uv.sources]
+python-ldap = [
+  # Christoph Gohlke distributes pre-compiled binaries of various Python packages,
+  # among others: https://github.com/cgohlke/python-ldap-build/releases.
+  # The library version must match the version selected under the `dev`
+  # dependency group, and the `cp3xx` version must match `requires-python`.
+  # URL found at https://github.com/cgohlke/python-ldap-build/releases/tag/v3.4.4-2
+  { url = "https://github.com/cgohlke/python-ldap-build/releases/download/v3.4.4-2/python_ldap-3.4.4-cp311-cp311-win_amd64.whl", marker = "sys_platform == 'win32'" },
+]