Rename package to mavis.reporting

Move code from the old mavis_reporting namespace to the
new mavis.reporting layout.

Author: tvararu

.env.example

@@ -1,12 +1,12 @@
-FLASK_APP=mavis_reporting:create_app
+FLASK_APP=mavis.reporting:create_app
 FLASK_ENV=development
 # Required by Flask - used internally
 SECRET_KEY=(some random hex string)
-# Used as part of the OAuth 2.0 Authorization Code flow 
-# to identify this application to Mavis when requesting an 
+# Used as part of the OAuth 2.0 Authorization Code flow
+# to identify this application to Mavis when requesting an
 # authorization code
 CLIENT_ID=(some random hex string)
 # Used for signing / decoding-and-verifying-the-signature-of JWTs
 CLIENT_SECRET=(some random hex string)
 MAVIS_ROOT_URL=http://localhost:4000/
-SESSION_TTL_SECONDS=600
+SESSION_TTL_SECONDS=600

.gitignore

@@ -13,14 +13,14 @@ __pycache__/
 .ruff_cache/
 node_modules/
 .idea/
-mavis_reporting/static/css/*
-!mavis_reporting/static/css/.keep
+mavis/reporting/static/css/*
+!mavis/reporting/static/css/.keep
 
-mavis_reporting/static/js/*
-!mavis_reporting/static/js/.keep
+mavis/reporting/static/js/*
+!mavis/reporting/static/js/.keep
 
-mavis_reporting/static/favicons/*
-!mavis_reporting/static/favicons/.keep
+mavis/reporting/static/favicons/*
+!mavis/reporting/static/favicons/.keep
 
 sentinel
 

Dockerfile

@@ -8,7 +8,7 @@ RUN apk add build-base libffi-dev npm bash curl
 
 RUN pip install uv
 
-ADD ./mavis_reporting /app/mavis_reporting
+ADD ./mavis/reporting /app/mavis/reporting
 ADD README.md /app/
 
 RUN uv sync --frozen --all-extras
@@ -30,4 +30,4 @@ USER 1000
 VOLUME ["/tmp", "/var/tmp", "/usr/tmp"]
 
 # pass through additional arguments like --workers=5 via GUNICORN_CMD_ARGS
-CMD ["uv", "run", "gunicorn", "--bind", "0.0.0.0:5000", "mavis_reporting:create_app()"]
+CMD ["uv", "run", "gunicorn", "--bind", "0.0.0.0:5000", "mavis.reporting:create_app()"]

Makefile

@@ -44,8 +44,8 @@ dev: install
 
 .PHONY: copy-nhsuk-favicons
 copy-nhsuk-favicons:
-	mkdir -p mavis_reporting/static/favicons
-	cp -r node_modules/nhsuk-frontend/dist/nhsuk/assets/images/* mavis_reporting/static/favicons/
+	mkdir -p mavis/reporting/static/favicons
+	cp -r node_modules/nhsuk-frontend/dist/nhsuk/assets/images/* mavis/reporting/static/favicons/
 
 build-docker:
 	docker build -t ${DOCKER_IMAGE} .

mavis/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

mavis_reporting/__init__.py mavis/reporting/__init__.pymavis_reporting/__init__.py renamed to mavis/reporting/__init__.py

@@ -1,6 +1,6 @@
 from flask import Flask, redirect
-from mavis_reporting.config import config
-from mavis_reporting.config.jinja2 import configure_jinja2
+from mavis.reporting.config import config
+from mavis.reporting.config.jinja2 import configure_jinja2
 
 import os
 
@@ -15,7 +15,7 @@ def create_app(config_name=None):
     configure_jinja2(app)
 
     # ruff: noqa: PLC0415
-    from mavis_reporting.views import main
+    from mavis.reporting.views import main
 
     app.register_blueprint(main, url_prefix="/reporting")