add conditional settings and new env vars

.env.example

@@ -0,0 +1,14 @@
+DJANGO_ENV=development
+DEBUG=true
+
+DJANGO_SECRET_KEY="your_secret_key"
+ALLOWED_HOSTS=localhost,127.0.0.1
+
+SQL_ENGINE=django.db.backends.postgresql
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_HOST=127.0.0.1
+POSTGRES_PORT=5432
+POSTGRES_DB=postgres
+DATABASE_URL=postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
+

.github/workflows/tests.yml

@@ -36,4 +36,6 @@ jobs:
 
  - name: Test
  run: |
- poetry run python manage.py test
+ poetry run python manage.py test
+ env:
+ DJANGO_ENV: github_actions

README.md

@@ -15,11 +15,11 @@ This tool is expected to read the data from a remote source (an S3 bucket or sim
 # Local Setup
 You need to have [python](https://www.python.org/) and [poetry](https://python-poetry).
 
-
-3. Install dependencies with `poetry install`;
-4. Launch a poetry shell so the virtual environment is active: `poetry shell`;
-5. Run `python manage.py migrate` to create the databases tables;
-6. Add the pre-commit hook by running `pre-commit install`. This will ensure your code is formatted before you commit something;
+1. Create an `.env` file by copying the `.env.example` one and editing the variables as needed.
+2. Install dependencies with `poetry install`;
+3. Launch a poetry shell so the virtual environment is active: `poetry shell`;
+4. Run `python manage.py migrate` to create the databases tables;
+5. Add the pre-commit hook by running `pre-commit install`. This will ensure your code is formatted before you commit something;
 
 ## Load fixtures
 To load some dummy data, run:

dm_regional_site/settings/__init__.py

@@ -0,0 +1,12 @@
+from decouple import config
+
+DJANGO_ENV = config("DJANGO_ENV", default="production")
+
+if DJANGO_ENV == "development":
+ from .development import * # NOQA
+
+elif DJANGO_ENV == "github_actions":
+ from .github_actions import * # NOQA
+
+else:
+ from .production import * # NOQA

dm_regional_site/settings.py → dm_regional_site/settings/base.py

@@ -12,6 +12,9 @@
 
 from pathlib import Path
 
+import dj_database_url
+from decouple import config
+
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
@@ -20,12 +23,16 @@
 # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = "django-insecure-gh4wp!kqd8#nc6_o)eqxs@_4w2+9+p(rq$bdz&d2*!jg946@w3"
-
+SECRET_KEY = config(
+ "DJANGO_SECRET_KEY",
+ default="django-insecure-gh4wp!kqd8#nc6_o)eqxs@_4w2+9+p(rq$bdz&d2*!jg946@w3",
+)
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
+DEBUG = config("DEBUG", default=False, cast=bool)
 
-ALLOWED_HOSTS = []
+ALLOWED_HOSTS = config(
+ "ALLOWED_HOSTS", cast=lambda v: [s.strip() for s in v.split(",")], default=""
+)
 
 
 # Application definition
@@ -84,12 +91,13 @@
 
 # Database
 # https://docs.djangoproject.com/en/4.2/ref/settings/#databases
-
+MAX_CONN_AGE = 600
 DATABASES = {
- "default": {
- "ENGINE": "django.db.backends.sqlite3",
- "NAME": BASE_DIR / "db.sqlite3",
- }
+ "default": dj_database_url.config(
+ default=config("DATABASE_URL", f"sqlite:///{BASE_DIR}/db.sqlite3"),
+ conn_max_age=MAX_CONN_AGE,
+ ssl_require=False,
+ ),
 }
 
 

dm_regional_site/settings/development.py

@@ -0,0 +1,3 @@
+from .base import * # NOQA
+
+# add development dedicated settings here

dm_regional_site/settings/github_actions.py

@@ -0,0 +1,3 @@
+from .base import * # NOQA
+
+# add github actions dedicated settings here

dm_regional_site/settings/production.py

@@ -0,0 +1,7 @@
+import django_heroku
+
+from .base import * # NOQA
+
+django_heroku.settings(locals())
+
+# add production dedicated settings here