Merge pull request #102 from NHSDigital/add-schema-diagrams

Add entity relationship diagram generation

Author: malcolmbaig

.pre-commit-config.yaml

@@ -7,6 +7,13 @@ repos:
         args: ['check=staged-changes']
         language: script
         pass_filenames: false
+      - id: generate-erd
+        name: Generate ERD
+        entry: make erd
+        language: system
+        pass_filenames: false
+        files: '.*models\.py$|.*models/.*\.py$'
+        
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
     rev: v0.11.12

Makefile

@@ -76,6 +76,10 @@ models:
 shell:
 	poetry run ./manage.py shell
 
+erd:
+	poetry run python -m django_diagram --settings manage_breast_screening.config.settings --output docs/diagrams/erd.md
+	sed -i '' '1s/^/```mermaid\n/' docs/diagrams/erd.md && printf '\n```\n' >> docs/diagrams/erd.md
+
 _install-poetry:
 	if ! command -v poetry >/dev/null 2>&1; then \
 		pip install poetry; \

README.md

@@ -110,6 +110,10 @@ To generate a new app, run:
 poetry run ./manage.py startapp <app_name> manage_breast_screening/`
 ```
 
+### Entity relationship
+
+[Mermaid ERD](docs/diagrams/erd.md)
+
 ## Manual Deployment
 
 The build pipeline builds and pushes a docker image to [Github container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry). The app is deployed to an [Azure container app](https://azure.microsoft.com/en-us/products/container-apps) using terraform.

docs/diagrams/erd.md

@@ -0,0 +1,158 @@
+```mermaid
+---
+Django ER Diagram
+---
+erDiagram
+LogEntry {
+    AutoField id
+    DateTimeField action_time
+    ForeignKey user
+    ForeignKey content_type
+    TextField object_id
+    CharField object_repr
+    PositiveSmallIntegerField action_flag
+    TextField change_message
+}
+Permission {
+    AutoField id
+    CharField name
+    ForeignKey content_type
+    CharField codename
+}
+Group {
+    AutoField id
+    CharField name
+    ManyToManyField permissions
+}
+User {
+    AutoField id
+    CharField password
+    DateTimeField last_login
+    BooleanField is_superuser
+    CharField username
+    CharField first_name
+    CharField last_name
+    CharField email
+    BooleanField is_staff
+    BooleanField is_active
+    DateTimeField date_joined
+    ManyToManyField groups
+    ManyToManyField user_permissions
+}
+ContentType {
+    AutoField id
+    CharField app_label
+    CharField model
+}
+Session {
+    CharField session_key
+    TextField session_data
+    DateTimeField expire_date
+}
+AuditLog {
+    UUIDField id
+    DateTimeField created_at
+    ForeignKey content_type
+    UUIDField object_id
+    CharField operation
+    JSONField snapshot
+    ForeignKey actor
+    CharField system_update_id
+}
+Provider {
+    UUIDField id
+    DateTimeField created_at
+    DateTimeField updated_at
+    TextField name
+}
+Setting {
+    UUIDField id
+    DateTimeField created_at
+    DateTimeField updated_at
+    TextField name
+    ForeignKey provider
+}
+Clinic {
+    UUIDField id
+    DateTimeField created_at
+    DateTimeField updated_at
+    ForeignKey setting
+    DateTimeField starts_at
+    DateTimeField ends_at
+    CharField type
+    CharField risk_type
+}
+ClinicSlot {
+    UUIDField id
+    DateTimeField created_at
+    DateTimeField updated_at
+    ForeignKey clinic
+    DateTimeField starts_at
+    IntegerField duration_in_minutes
+}
+ClinicStatus {
+    UUIDField id
+    DateTimeField created_at
+    CharField state
+    ForeignKey clinic
+}
+Participant {
+    UUIDField id
+    DateTimeField created_at
+    DateTimeField updated_at
+    TextField first_name
+    TextField last_name
+    TextField gender
+    TextField nhs_number
+    TextField phone
+    CharField email
+    DateField date_of_birth
+    CharField ethnic_group
+    TextField risk_level
+    JSONField extra_needs
+}
+ParticipantAddress {
+    UUIDField id
+    OneToOneField participant
+    ArrayField lines
+    CharField postcode
+}
+ScreeningEpisode {
+    UUIDField id
+    DateTimeField created_at
+    DateTimeField updated_at
+    ForeignKey participant
+}
+Appointment {
+    UUIDField id
+    DateTimeField created_at
+    DateTimeField updated_at
+    ForeignKey screening_episode
+    ForeignKey clinic_slot
+    BooleanField reinvite
+    JSONField stopped_reasons
+}
+AppointmentStatus {
+    CharField state
+    UUIDField id
+    DateTimeField created_at
+    ForeignKey appointment
+}
+LogEntry }|--|| User : user
+LogEntry }|--|| ContentType : content_type
+Permission }|--|| ContentType : content_type
+Group }|--|{ Permission : permissions
+User }|--|{ Group : groups
+User }|--|{ Permission : user_permissions
+AuditLog }|--|| ContentType : content_type
+AuditLog }|--|| User : actor
+Setting }|--|| Provider : provider
+Clinic }|--|| Setting : setting
+ClinicSlot }|--|| Clinic : clinic
+ClinicStatus }|--|| Clinic : clinic
+ParticipantAddress ||--|| Participant : participant
+ScreeningEpisode }|--|| Participant : participant
+Appointment }|--|| ScreeningEpisode : screening_episode
+Appointment }|--|| ClinicSlot : clinic_slot
+AppointmentStatus }|--|| Appointment : appointment
+```

poetry.lock

@@ -31,6 +31,7 @@ ipdb = "^0.13.13"
 axe-playwright-python = "^0.1.5"
 ruff = "^0.12.0"
 django-debug-toolbar = "^5.2.0"
+django-diagram = "^0.0.1"
 
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]