Issue 12 - Adjustments for non-local deployments (#17)

* add whitenoise middleware to serve static files
* move more local/env-dependent settings from settings.py to
settings.ini or env-vars
* add an example for settings.ini

Closes #12

Author: JosePizarro3

.github/workflows/actions.yml

@@ -38,6 +38,12 @@ jobs:
     - name: Test with pytest
       run: |
         python -m pytest -sv tests
+    - name: Ruff linting
+      run: |
+        ruff check .
+    - name: Ruff formatting
+      run: |
+        ruff format . --check --verbose
   build-and-install:
     runs-on: ubuntu-latest
     steps:
@@ -55,18 +61,4 @@ jobs:
         python -m build --sdist
     - name: Install the package
       run: |
-        uv pip install dist/*.tar.gz
-  ruff-linting:
-      runs-on: ubuntu-latest
-      steps:
-        - uses: actions/checkout@v4
-        - uses: chartboost/ruff-action@v1
-          with:
-            args: "check ."
-  ruff-formatting:
-      runs-on: ubuntu-latest
-      steps:
-        - uses: actions/checkout@v4
-        - uses: chartboost/ruff-action@v1
-          with:
-            args: "format . --check --verbose"
+        uv pip install dist/*.tar.gz

masterdata_checker/checker/settings.ini.example

@@ -0,0 +1,7 @@
+[settings]
+DEBUG=False
+SECRET_KEY=django-insecure-wiq2-hvjf4#jgoq-&#rg!)hw*(wa9l9^&cgcohq8k6ihitx9f#
+SECRET_ENCRYPTION_KEY=x1_JDNmuikh7MQFzIQJFvmJDFbeOsacJRvvvwq3xv6a=
+ALLOWED_HOSTS = 127.0.0.1, localhost
+CSRF_TRUSTED_ORIGINS = https://mdc.domain.local
+

masterdata_checker/checker/settings.py

@@ -30,9 +30,13 @@
 OPENBIS_URL = "https://main.datastore.bam.de/"
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = False
+DEBUG = environ("DEBUG", default=False, cast=bool)
 
-ALLOWED_HOSTS = ["localhost", "127.0.0.1", "141.63.249.193", "141.63.249.2"]
+ALLOWED_HOSTS = environ(
+    "ALLOWED_HOSTS",
+    default=["127.0.0.1", "localhost"],
+    cast=lambda v: [s.strip() for s in v.split(",")],
+)
 
 CACHES = {
     "default": {
@@ -55,6 +59,7 @@
 
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.middleware.common.CommonMiddleware",
     "django.middleware.csrf.CsrfViewMiddleware",
@@ -63,9 +68,11 @@
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-CSRF_TRUSTED_ORIGINS = ["http://141.63.249.193:8000"]
+CSRF_TRUSTED_ORIGINS = environ(
+    "CSRF_TRUSTED_ORIGINS", default=[], cast=lambda v: [s.strip() for s in v.split(",")]
+)
 
-ROOT_URLCONF = "checker.urls"
+ROOT_URLCONF = "masterdata_checker.checker.urls"
 
 TEMPLATES = [
     {
@@ -83,7 +90,7 @@
     },
 ]
 
-WSGI_APPLICATION = "checker.wsgi.application"
+WSGI_APPLICATION = "masterdata_checker.checker.wsgi.application"
 
 
 # Database
@@ -148,6 +155,8 @@
 
 STATIC_URL = "/static/"
 STATICFILES_DIRS = [BASE_DIR / "app/static"]
+STATIC_ROOT = BASE_DIR / "staticfiles"
+STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field

masterdata_checker/manage.py

@@ -7,7 +7,9 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "checker.settings")
+    os.environ.setdefault(
+        "DJANGO_SETTINGS_MODULE", "masterdata_checker.checker.settings"
+    )
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:

pyproject.toml

@@ -30,6 +30,7 @@ license = { file = "LICENSE" }
 dependencies = [
   "bam-masterdata>=0.4.2",
   "django",
+  "whitenoise",
   "pybis~=1.37.1rc4",
   "cryptography>=45.0.2",
   "python-decouple",
@@ -42,7 +43,7 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
   "mypy==1.0.1",
-  "ruff",
+  "ruff==0.11.4",
   "pytest",
   "pytest-timeout",
   "pytest-cov",