Entity Relationship Diagrams

.github/workflows/test.yml

@@ -76,7 +76,9 @@ jobs:
           python-version: 3.11
           cache: 'poetry'
       - name: Install Python dependencies
-        run: poetry install
+        run: |
+          sudo apt-get install --yes --quiet --no-install-recommends graphviz libgraphviz-dev
+          poetry install
       - name: System checks
         run: poetry run ./manage.py check
       - name: Check for missing migrations

Dockerfile

@@ -58,6 +58,12 @@ ENV PATH=$VIRTUAL_ENV/bin:$PATH \
 ARG BUILD_ENV
 ENV BUILD_ENV=${BUILD_ENV}
 
+# install graphviz only in dev environment
+RUN if [ "$BUILD_ENV" = "dev" ] ; then \
+    apt-get update --yes --quiet && apt-get install --yes --quiet --no-install-recommends \
+    graphviz libgraphviz-dev \
+    && apt-get autoremove && rm -rf /var/lib/apt/lists/* ; \
+    fi
 
 # Port exposed by this container. Should default to the port used by your WSGI
 # server (Gunicorn). This is read by Dokku only. Heroku will ignore this.

pyproject.toml

@@ -9,7 +9,7 @@ python = "^3.11"
 Django = "~4.2"
 wagtail = "~5.2"
 psycopg2 = "^2.9.3"
-gunicorn = {version = "^20.1.0", optional = true}
+gunicorn = { version = "^20.1.0", optional = true }
 django-pattern-library = "^1.1.0"
 whitenoise = "^6.1.0"
 dj-database-url = "^0.5.0"
@@ -37,11 +37,14 @@ gunicorn = ["gunicorn"]
 [tool.poetry.dev-dependencies]
 Werkzeug = "^2.1.2"
 django-debug-toolbar = "^4.1.0"
-django-extensions = "^3.2.1"
+django-extensions = "^3.2.3"
 fabric = "~2.5"
 stellar = "^0.4.5"
 pudb = "^2020.1"
 honcho = "^1.1.0"
+pygraphviz = "^1.11"
+pyparsing = "^3.1.1"
+pydot = "^1.4.2"
 
 # Linters etc.
 black = "^22.3.0"

tbx/settings/dev.py

@@ -47,6 +47,8 @@
     "SHOW_COLLAPSED": True,
 }
 
+INSTALLED_APPS += ["django_extensions"]  # noqa
+
 try:
     from .local import *  # noqa
 except ImportError: