graph django models

.github/workflows/main.yml

@@ -25,14 +25,20 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+  docs:
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - uses: ocadotechnology/codeforlife-workspace/.github/actions/python/docs@actions # TODO: use @main
+
   release:
     concurrency: release
     runs-on: ubuntu-latest
-    needs: [test]
+    needs: [docs]
     if: github.ref_name == 'main'
     steps:
       - name: 🛫 Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
           fetch-depth: 0

.gitignore

@@ -40,10 +40,10 @@ pip-log.txt
 pip-delete-this-directory.txt
 
 # Any graphs generated in the docs
-docs/*.png
+# docs/*.png
 
 # Any dot files generated by pydot
-*.dot
+# *.dot
 
 # Unit test / coverage reports
 htmlcov/

Pipfile

@@ -27,6 +27,7 @@ django-stubs = {version = "==4.2.6", extras = ["compatible-mypy"]}
 djangorestframework-stubs = {version = "==3.14.4", extras = ["compatible-mypy"]}
 pylint = "==3.0.2"
 pylint-django = "==2.5.5"
+pygraphviz = "==1.11"
 
 [requires]
 python_version = "3.8"

codeforlife/settings/third_party.py

@@ -23,3 +23,16 @@
     ],
     "DEFAULT_PAGINATION_CLASS": "codeforlife.pagination.LimitOffsetPagination",
 }
+
+# Django Extensions - Graph Models
+# https://django-extensions.readthedocs.io/en/latest/graph_models.html?highlight=graph_models#default-settings
+
+GRAPH_MODELS = {
+    "all_applications": True,
+    "group_models": True,
+    "pygraphviz": True,
+    "output": "docs/entity_relationship_diagram.png",
+    "arrow_shape": "normal",
+    "color_code_deletions": True,
+    "rankdir": "BT",
+}

manage.py

@@ -13,6 +13,7 @@
     "django.contrib.staticfiles",
     "django.contrib.sites",
     "codeforlife.user",
+    "django_extensions",
 ]
 
 MIDDLEWARE = [