Install dj-database-url

nationalarchives · Nov 12, 2024 · 8272b23 · 8272b23
1 parent 81396f2
commit 8272b23
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 40 deletions.
diff --git a/.isort.cfg b/.isort.cfg
@@ -0,0 +1,6 @@
+[settings]
+profile=black
+sections=FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+known_first_party=config
+known_django=django
+default_section=THIRDPARTY
diff --git a/README.md b/README.md
@@ -35,26 +35,22 @@ docker compose exec dev format
 
 In addition to the [base Docker image variables](https://github.com/nationalarchives/docker/blob/main/docker/tna-python-django/README.md#environment-variables), this application has support for:
 
-| Variable                 | Purpose                                                   | Default                                                   |
-| ------------------------ | --------------------------------------------------------- | --------------------------------------------------------- |
-| `DJANGO_SETTINGS_MODULE` | The configuration to use                                  | `config.settings.production`                              |
-| `ALLOWED_HOSTS`          | A comma-separated list of allowed hosts                   | _none_ on production and staging, `*` on develop and test |
-| `USE_X_FORWARDED_HOST`   | Use the `X-Forwarded-Host` header in preference to `Host` | `False`                                                   |
-| `DEBUG`                  | If true, allow debugging                                  | `False`                                                   |
-| `COOKIE_DOMAIN`          | The domain to save cookie preferences against             | _none_                                                    |
-| `DATABASE_NAME`          | The name of the Postgres database                         | _none_                                                    |
-| `DATABASE_USER`          | The username needed to access the Postgres database       | _none_                                                    |
-| `DATABASE_PASSWORD`      | The password needed to access the Postgres database       | _none_                                                    |
-| `DATABASE_HOST`          | The Postgres database host                                | _none_                                                    |
-| `DATABASE_PORT`          | The Postgres database port                                | `5432`                                                    |
-| `CSP_IMG_SRC`            | A comma separated list of CSP rules for `img-src`         | `'self'`                                                  |
-| `CSP_SCRIPT_SRC`         | A comma separated list of CSP rules for `script-src`      | `'self'`                                                  |
-| `CSP_SCRIPT_SRC_ELEM`    | A comma separated list of CSP rules for `script-src-elem` | `'self'`                                                  |
-| `CSP_STYLE_SRC`          | A comma separated list of CSP rules for `style-src`       | `'self'`                                                  |
-| `CSP_STYLE_SRC_ELEM`     | A comma separated list of CSP rules for `style-src-elem`  | `'self'`                                                  |
-| `CSP_FONT_SRC`           | A comma separated list of CSP rules for `font-src`        | `'self'`                                                  |
-| `CSP_CONNECT_SRC`        | A comma separated list of CSP rules for `connect-src`     | `'self'`                                                  |
-| `CSP_MEDIA_SRC`          | A comma separated list of CSP rules for `media-src`       | `'self'`                                                  |
-| `CSP_WORKER_SRC`         | A comma separated list of CSP rules for `worker-src`      | `'self'`                                                  |
-| `CSP_FRAME_SRC`          | A comma separated list of CSP rules for `frame-src`       | `'self'`                                                  |
-| `GA4_ID`                 | The Google Analytics 4 ID                                 | _none_                                                    |
+| Variable                 | Purpose                                                        | Default                                                   |
+| ------------------------ | -------------------------------------------------------------- | --------------------------------------------------------- |
+| `DJANGO_SETTINGS_MODULE` | The configuration to use                                       | `config.settings.production`                              |
+| `ALLOWED_HOSTS`          | A comma-separated list of allowed hosts                        | _none_ on production and staging, `*` on develop and test |
+| `USE_X_FORWARDED_HOST`   | Use the `X-Forwarded-Host` header in preference to `Host`      | `False`                                                   |
+| `DEBUG`                  | If true, allow debugging                                       | `False`                                                   |
+| `COOKIE_DOMAIN`          | The domain to save cookie preferences against                  | _none_                                                    |
+| `DATABASE_URL`           | The database's URL (`postgres://USER:PASSWORD@HOST:PORT/NAME`) | _none_                                                    |
+| `CSP_IMG_SRC`            | A comma separated list of CSP rules for `img-src`              | `'self'`                                                  |
+| `CSP_SCRIPT_SRC`         | A comma separated list of CSP rules for `script-src`           | `'self'`                                                  |
+| `CSP_SCRIPT_SRC_ELEM`    | A comma separated list of CSP rules for `script-src-elem`      | `'self'`                                                  |
+| `CSP_STYLE_SRC`          | A comma separated list of CSP rules for `style-src`            | `'self'`                                                  |
+| `CSP_STYLE_SRC_ELEM`     | A comma separated list of CSP rules for `style-src-elem`       | `'self'`                                                  |
+| `CSP_FONT_SRC`           | A comma separated list of CSP rules for `font-src`             | `'self'`                                                  |
+| `CSP_CONNECT_SRC`        | A comma separated list of CSP rules for `connect-src`          | `'self'`                                                  |
+| `CSP_MEDIA_SRC`          | A comma separated list of CSP rules for `media-src`            | `'self'`                                                  |
+| `CSP_WORKER_SRC`         | A comma separated list of CSP rules for `worker-src`           | `'self'`                                                  |
+| `CSP_FRAME_SRC`          | A comma separated list of CSP rules for `frame-src`            | `'self'`                                                  |
+| `GA4_ID`                 | The Google Analytics 4 ID                                      | _none_                                                    |
diff --git a/config/jinja2.py b/config/jinja2.py
@@ -5,6 +5,7 @@
 from django.conf import settings
 from django.templatetags.static import static
 from django.urls import reverse
+
 from jinja2 import Environment
 
 

diff --git a/config/settings/base.py b/config/settings/base.py
@@ -3,6 +3,8 @@
 from pathlib import Path
 from sysconfig import get_path
 
+import dj_database_url
+
 from config.util import strtobool
 
 PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -69,16 +71,8 @@
 # Database
 # https://docs.djangoproject.com/en/5.0/ref/settings/#databases
 
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.postgresql",
-        "NAME": os.environ.get("DATABASE_NAME", ""),
-        "USER": os.environ.get("DATABASE_USER", ""),
-        "PASSWORD": os.environ.get("DATABASE_PASSWORD", ""),
-        "HOST": os.environ.get("DATABASE_HOST", ""),
-        "PORT": os.environ.get("DATABASE_PORT", "5432"),
-    }
-}
+DATABASES = {"default": dj_database_url.config(conn_max_age=600)}
+
 
 # Password validation
 # https://docs.djangoproject.com/en/5.0/ref/settings/#auth-password-validators

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -10,11 +10,7 @@ services:
       - DJANGO_SETTINGS_MODULE=config.settings.develop
       - SECRET_KEY=abc123
       - NPM_DEVELOP_COMMAND=dev
-      - DATABASE_NAME=postgres
-      - DATABASE_USER=postgres
-      - DATABASE_PASSWORD=postgres
-      - DATABASE_HOST=db
-      - DATABASE_PORT=5432
+      - DATABASE_URL=postgres://postgres:postgres@db:5432/postgres
       - DJANGO_SUPERUSER_PASSWORD=admin
       - DJANGO_SUPERUSER_USERNAME=admin
       - COOKIE_DOMAIN=localhost

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,6 +14,7 @@ django = "^5.0.7"
 psycopg2-binary = "^2.9.9"
 django-csp = "^3.8"
 whitenoise = "^6.7.0"
+dj-database-url = "^2.3.0"
 
 [tool.poetry.group.dev]
 optional = true