Tweaked dockerfile to add Make, changing filenames to standardise, starting to document run process.

Author: smangham

.env.default

@@ -1,7 +1,5 @@
 DEBUG=True
 DEBUG_IOMMI=True
-# When false, access control is turned off
-DEBUG_ACCESS=True
 # Generated from http://portal.azure.com/ -> Cloud shell
 # Connect-AzureAD
 # $azureADAppReg = New-AzureADApplication -DisplayName TeachingTimeTool -AvailableToOtherTenants $false

Dockerfile

@@ -1,6 +1,6 @@
 FROM ghcr.io/astral-sh/uv:alpine
 
-RUN apk add --update gcc linux-headers musl-dev openldap-dev python3-dev bash
+RUN apk add --update gcc linux-headers musl-dev openldap-dev python3-dev bash make
 
 # set environment variables
 ENV PIP_DISABLE_PIP_VERSION_CHECK 1

README.md

@@ -1,2 +1,43 @@
 # Teaching Time Tool
 
+## Installation
+
+Clone the repo to the server:
+
+```bash
+cd /var/www/
+git clone https://github.com/Southampton-RSG/physics-workload
+```
+
+## Running
+
+The tool is run using `docker compose`. Generally, it's best to do this in a `screen` session.
+Start the server (and associated containers) using:
+
+```bash
+screen
+sudo docker compose up
+```
+
+### Initialising
+
+If you're running this the first time, the database has to be initialised.
+This will populate the database with 
+
+```bash
+sudo docker exec -it physics-workload-django /bin/bash 
+make clean
+make data
+```
+
+
+## Updating
+
+To update the tool, take the containers down, rebuild, and restart using:
+
+```bash
+screen -r
+sudo docker compose down 
+sudo docker compose build --no-cache
+sudo docker compose up
+```

scripts/import_unit_tasks_from_csv.py

@@ -23,7 +23,7 @@
 # logger.propagate = True
 
 # Hardcoded for ease of dealing with the manage.py shell.
-CSV_PATH: Path = Path(getcwd()) / "staff_tasks_unit.csv"
+CSV_PATH: Path = Path(getcwd()) / "spreadsheet_tasks_unit.csv"
 logger.info(f"Importing units from: {CSV_PATH}")
 
 # Track the history of creation