refactor(django): Use UV Workspaces and src-layout for scram django app

.github/workflows/behave.yml

@@ -80,14 +80,15 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: coverage-report
-          path: coverage.xml
+          path: django/coverage.xml
 
       - name: Display Coverage Metrics
         if: matrix.python-version == '3.12'
         uses: 5monkeys/cobertura-action@v14
         with:
           minimum_coverage: "50"
           report_name: "Django Pytest/Behave Coverage"
+          path: django/coverage.xml
 
 
       - name: Check Docker state (post-test)

.github/workflows/pytest.yml

@@ -61,25 +61,26 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install uv pytest-github-actions-annotate-failures
-          uv pip install --system -r requirements/local.txt --prerelease=allow
+          uv pip install --system -r django/requirements/local.txt --prerelease=allow
 
       - name: Apply migrations
         env:
           DATABASE_URL: "postgres://scram:@localhost:5432/test_scram_${{ matrix.python-version }}"
         run: |
+          cd django/src
           python manage.py makemigrations --noinput
           python manage.py migrate --noinput
 
       - name: Check for missing migrations
         env:
           DATABASE_URL: "postgres://scram:@localhost:5432/test_scram_${{ matrix.python-version }}"
-        run: python manage.py makemigrations --check
+        run: cd django/src && python manage.py makemigrations --check
 
       - name: Run Pytest
         env:
           DATABASE_URL: "postgres://scram:@localhost:5432/test_scram_${{ matrix.python-version }}"
           REDIS_HOST: "localhost"
-        run: pytest
+        run: cd django/src && pytest
 
       - name: Install Scheduler Dependencies
         run: |

.github/workflows/pytest_next_python.yml

@@ -56,14 +56,15 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install uv
-          uv pip install --system -r requirements/local.txt --prerelease=allow
+          uv pip install --system -r django/requirements/local.txt --prerelease=allow
           # https://github.com/pytest-dev/pytest-github-actions-annotate-failures/pull/68 isn't yet in a release
           uv pip install --system git+https://github.com/pytest-dev/pytest-github-actions-annotate-failures.git@6e66cd895fe05cd09be8bad58f5d79110a20385f
 
       - name: Apply unapplied migrations
         env:
           DATABASE_URL: "postgres://scram:@localhost:5432/test_scram"
         run: |
+          cd django/src
           python manage.py makemigrations --noinput || true
           UNAPPLIED_MIGRATIONS=$(python manage.py showmigrations --plan | grep '\[ \]' | awk '{print $2}')
           if [ -n "$UNAPPLIED_MIGRATIONS" ]; then
@@ -76,6 +77,7 @@ jobs:
 
       - name: Check for duplicate migrations
         run: |
+          cd django/src
           if python manage.py makemigrations --dry-run | grep "No changes detected"; then
             echo "No duplicate migrations detected."
           else
@@ -87,4 +89,4 @@ jobs:
           DATABASE_URL: "postgres://scram:@localhost:5432/test_scram"
           REDIS_HOST: "localhost"
         run: |
-          pytest || echo "::warning:: Failed on future Python version ${{ matrix.python-version }}."
+          cd django/src && pytest || echo "::warning:: Failed on future Python version ${{ matrix.python-version }}."

.vscode/launch.json

@@ -14,7 +14,7 @@
             },
             "pathMappings": [
                 {
-                    "localRoot": "${workspaceFolder}",
+                    "localRoot": "${workspaceFolder}/django",
                     "remoteRoot": "/app"
                 }
             ]
@@ -29,7 +29,7 @@
           },
           "pathMappings": [
               {
-                  "localRoot": "${workspaceFolder}",
+                  "localRoot": "${workspaceFolder}/django",
                   "remoteRoot": "/app"
               }
           ]

Makefile

@@ -26,17 +26,17 @@ compose.override.yml:
 ## behave-all: runs behave inside the containers against all of your features
 .Phony: behave-all
 behave-all: compose.override.yml
-	@docker compose run --rm django coverage run -a manage.py behave --no-input --simple
+	@docker compose run --rm -w /app -e PYTHONPATH=/app/src django coverage run -a src/manage.py behave --no-input --simple
 
 ## behave: runs behave inside the containers against a specific feature (append FEATURE=feature_name_here)
 .Phony: behave
 behave: compose.override.yml
-	@docker compose run --rm django python manage.py behave --no-input --simple -i $(FEATURE)
+	@docker compose run --rm -w /app -e PYTHONPATH=/app/src django python src/manage.py behave --no-input --simple -i $(FEATURE)
 
 ## integration-tests: runs multi-instance system tests against docker compose running containers
 .Phony: integration-tests
 integration-tests: run
-	@docker compose exec -T django coverage run -a manage.py behave --no-input --use-existing-database scram/route_manager/tests/integration
+	@docker compose exec -T -w /app -e PYTHONPATH=/app/src django coverage run -a src/manage.py behave --no-input --use-existing-database src/scram/route_manager/tests/integration
 
 ## behave-translator
 .Phony: behave-translator
@@ -52,8 +52,8 @@ build: compose.override.yml
 
 ## coverage.xml: generate coverage from test runs
 coverage.xml: pytest behave-all integration-tests behave-translator
-	@docker compose run --rm django coverage report
-	@docker compose run --rm django coverage xml
+	@docker compose run --rm -w /app django coverage report
+	@docker compose run --rm -w /app django coverage xml
 
 ## ci-test: runs all tests just like Github CI does
 .Phony: ci-test
@@ -127,7 +127,7 @@ pass-reset: compose.override.yml
 ## pytest: runs pytest inside the containers
 .Phony: pytest
 pytest: compose.override.yml
-	@docker compose run --rm django coverage run -m pytest
+	@docker compose run --rm -w /app -e PYTHONPATH=/app/src django coverage run -m pytest
 
 ## pytest-scheduler: runs scheduler package tests with coverage
 .Phony: pytest-scheduler
@@ -152,7 +152,7 @@ tail-log: compose.override.yml
 ## type-check: static type checking
 .Phony: type-check
 type-check: compose.override.yml
-	@docker compose run --rm django mypy scram
+	@docker compose run --rm -w /app -e PYTHONPATH=/app/src django mypy src/scram
 
 ## docs-build: build the documentation
 .Phony: docs-build

compose.override.local.yml

@@ -11,7 +11,7 @@ services:
       dockerfile: ./compose/local/django/Dockerfile
     image: scram_local_django
     volumes:
-      - $CI_PROJECT_DIR:/app:z
+      - $CI_PROJECT_DIR/django:/app:z
       - /tmp/profile_data:/tmp/profile_data
     env_file:
       - ./.envs/.local/.django
@@ -33,7 +33,7 @@ services:
       dockerfile: ./compose/local/django/Dockerfile
     image: scram_local_django
     volumes:
-      - $CI_PROJECT_DIR:/app:z
+      - $CI_PROJECT_DIR/django:/app:z
       - /tmp/profile_data:/tmp/profile_data
     env_file:
       - ./.envs/.local/.django

compose.override.production.yml

@@ -21,7 +21,7 @@ services:
       - path: '/etc/vault.d/secrets/kv_root_security.env'
         required: false
     volumes:
-      - ./staticfiles:/staticfiles
+      - ./django/staticfiles:/staticfiles
     healthcheck:
       test: ["CMD", "curl", "-f", "http://django:5000/process_updates/"]
 
@@ -58,7 +58,7 @@ services:
       - ./compose/production/nginx/nginx.conf:/etc/nginx/conf.d/default.conf
       - /etc/letsencrypt/live/${HOSTNAME}/fullchain.pem:/etc/ssl/server.crt
       - /etc/letsencrypt/live/${HOSTNAME}/privkey.pem:/etc/ssl/server.key
-      - ./staticfiles:/staticfiles
+      - ./django/staticfiles:/staticfiles
     ports:
       - "443:443"
       - "80:80"

compose/local/django/Dockerfile

@@ -18,7 +18,7 @@ RUN apt-get update \
   && rm -rf /var/lib/apt/lists/*
 
 # Requirements are installed here to ensure they will be cached.
-COPY ./requirements /requirements
+COPY ./django/requirements /requirements
 RUN pip install uv
 RUN uv pip install --system -r /requirements/local.txt --prerelease=allow
 
@@ -30,7 +30,7 @@ COPY ./compose/local/django/start /start
 RUN sed -i 's/\r$//g' /start
 RUN chmod +x /start
 
-ENV PATH="$PATH:/app"
-WORKDIR /app
+ENV PATH="$PATH:/app/src"
+WORKDIR /app/src
 
 ENTRYPOINT ["/entrypoint"]

compose/local/docs/Dockerfile

@@ -24,7 +24,7 @@ RUN apt-get update \
 
 
 # Only re-run the pip install if these files have changed
-COPY requirements/base.txt requirements/local.txt requirements/production.txt /app/requirements/
+COPY django/requirements/base.txt django/requirements/local.txt django/requirements/production.txt /app/requirements/
 RUN pip install uv
 RUN uv pip install --system -r /app/requirements/local.txt -r /app/requirements/production.txt --prerelease=allow
 

compose/production/django/Dockerfile

@@ -21,7 +21,7 @@ RUN addgroup --system django \
     && adduser --system --ingroup django django
 
 # Requirements are installed here to ensure they will be cached.
-COPY ./requirements/ /requirements
+COPY ./django/requirements/ /requirements
 RUN pip install uv
 RUN uv pip install --system --no-cache-dir -r /requirements/production.txt \
     && rm -rf /requirements
@@ -34,10 +34,10 @@ COPY --chown=django:django ./compose/production/django/start /start
 RUN sed -i 's/\r$//g' /start
 RUN chmod +x /start
 
-COPY --chown=django:django . /app
+COPY --chown=django:django ./django /app
 
 USER django
 
-WORKDIR /app
+WORKDIR /app/src
 
 ENTRYPOINT ["/entrypoint"]

compose/production/django/start

@@ -5,7 +5,7 @@ set -o pipefail
 set -o nounset
 
 
-python /app/manage.py collectstatic --noinput
+python /app/src/manage.py collectstatic --noinput
 
 
-/usr/local/bin/gunicorn config.asgi --bind 0.0.0.0:5000 --chdir=/app -k uvicorn.workers.UvicornWorker
+/usr/local/bin/gunicorn config.asgi --bind 0.0.0.0:5000 --chdir=/app/src -k uvicorn.workers.UvicornWorker

django/pyproject.toml

@@ -0,0 +1,83 @@
+[project]
+name = "scram-django"
+version = "1.5.1"
+
+# ==== pytest ====
+[tool.pytest.ini_options]
+addopts = [
+  "--ds=config.settings.test",
+  "--reuse-db",
+]
+minversion = "6.0"
+pythonpath = ["src"]
+python_files = [
+  "tests.py",
+  "test_*.py",
+]
+
+# ==== Coverage ====
+[tool.coverage.run]
+branch = true
+data_file = "coverage.coverage"
+include = ["src/scram/*", "src/config/*"]
+omit = ["**/migrations/*", "src/scram/contrib/*", "*/tests/*"]
+plugins = ["django_coverage_plugin"]
+
+[tool.coverage.report]
+exclude_also = [
+  "if debug:",
+  "if self.debug:",
+  "if settings.DEBUG",
+  "raise AssertionError",
+  "raise NotImplementedError",
+  "if __name__ == .__main__.:",
+]
+
+# ===== ruff ====
+# Base ruff config is inherited from the root pyproject.toml.
+[tool.ruff]
+exclude = ["migrations"]
+
+[tool.ruff.lint.per-file-ignores]
+"src/scram/route_manager/**" = [
+  "DOC201", # documenting return values
+]
+"src/scram/users/**" = [
+  "DOC201", # documenting return values
+  "FBT001", # minimal issue; don't need to mess with in the User app
+  "PLR2004", # magic values when checking HTTP status codes
+]
+"test.py" = [
+  "S105", # hardcoded password as argument
+]
+
+# ==== mypy ====
+[tool.mypy]
+check_untyped_defs = true
+exclude = ["src/scram/route_manager/tests"]
+ignore_missing_imports = true
+plugins = [
+  "mypy_django_plugin.main",
+  # We did used to have mypy_drf_plugin.main but it seems like it never actually worked...
+]
+python_version = "3.12"
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[[tool.mypy.overrides]]
+# Django migrations should not produce any errors:
+ignore_errors = true
+module = "*.migrations.*"
+
+[tool.django-stubs]
+django_settings_module = "config.settings.test"
+
+# ==== behave ====
+[tool.behave]
+paths = ["src/scram/route_manager/tests/acceptance"]
+stderr_capture = false
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

config/asgi.py → django/src/config/asgi.py

@@ -9,8 +9,6 @@
 
 import logging
 import os
-import sys
-from pathlib import Path
 
 # TODO: from channels.auth import AuthMiddlewareStack
 from channels.routing import ProtocolTypeRouter, URLRouter
@@ -25,11 +23,15 @@
 if debug:
     logger.info("Django is set to use a debugger. Provided debug mode: %s", debug)
     if debug == "pycharm-pydevd":
-        logger.info("Entering debug mode for pycharm, make sure the debug server is running in PyCharm!")
+        logger.info(
+            "Entering debug mode for pycharm, make sure the debug server is running in PyCharm!"
+        )
 
         import pydevd_pycharm
 
-        pydevd_pycharm.settrace("host.docker.internal", port=56783, stdoutToServer=True, stderrToServer=True)
+        pydevd_pycharm.settrace(
+            "host.docker.internal", port=56783, stdoutToServer=True, stderrToServer=True
+        )
 
         logger.info("Debugger started.")
     elif debug == "debugpy":
@@ -43,11 +45,6 @@
     else:
         logger.warning("Invalid debug mode given: %s. Debugger not started", debug)
 
-# This allows easy placement of apps within the interior
-# scram directory.
-ROOT_DIR = Path(__file__).resolve(strict=True).parent.parent
-sys.path.append(str(ROOT_DIR / "scram"))
-
 # If DJANGO_SETTINGS_MODULE is unset, default to the local settings
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local")