Adapt settings to Django 4

Author: matijapretnar

docker-compose.yml

@@ -27,4 +27,5 @@ services:
       - SOCIAL_AUTH_GOOGLE_OAUTH2_KEY
       - SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET
       - SOCIAL_AUTH_FACEBOOK_KEY
-      - SOCIAL_AUTH_FACEBOOK_SECRET
+      - SOCIAL_AUTH_FACEBOOK_SECRET
+      - SUBMISSION_URL

example.env

@@ -7,4 +7,5 @@ HTTP_PORT=8000
 ALLOWED_HOSTS=127.0.0.1
 SECRET_KEY=t2-r&t0yj0b%q$b^@ptqya=13mq0rsz1_5&h^ub-=+(ueiqsql
 DJANGO_SETTINGS_MODULE=web.settings.docker
-STATIC_PATH=./data/static
+STATIC_PATH=./data/static
+SUBMISSION_URL=http://127.0.0.1:8000

web/Dockerfile

@@ -9,14 +9,12 @@ RUN mkdir -p /var/static
 RUN chown -R tomo /src /var/static
 USER tomo
 ENV UWSGI_CHDIR=/src
-ENV UWSGI_MODULE=web.wsgi.docker:application
+ENV UWSGI_MODULE=web.wsgi:application
 ENV UWSGI_MASTER=True
-# Enables us to simply restart UWSGI by deleting /tmp/project-master.pid
-ENV UWSGI_PIDFILE=/tmp/project-master.pid
 ENV UWSGI_VACUUM=True
 ENV UWSGI_MAX_REQUESTS=5000
 ENV UWSGI_UID=tomo
 ENV UWSGI_GID=tomo
-ENV UWSGI_HTTP=:8080
+ENV UWSGI_SOCKET=:8080
 ENV UWSGI_STATIC_MAP=/static=/var/static
-CMD ./manage.py migrate --no-input && ./manage.py collectstatic --no-input && uwsgi
+CMD uwsgi

web/manage.py

@@ -1,10 +1,22 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
 import os
 import sys
 
-if __name__ == "__main__":
+
+def main():
+    """Run administrative tasks."""
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "web.settings.local")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
 
-    from django.core.management import execute_from_command_line
 
-    execute_from_command_line(sys.argv)
+if __name__ == "__main__":
+    main()

web/web/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for web project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "web.settings.local")
+
+application = get_asgi_application()

web/web/settings/arnes.py

@@ -1,21 +1,12 @@
 from .docker import *
 
-DEBUG = False
-
-WSGI_APPLICATION = "web.wsgi.arnes.application"
-
-MIDDLEWARE = (
-    "django.contrib.sessions.middleware.SessionMiddleware",
-    "django.middleware.locale.LocaleMiddleware",
-    "django.middleware.common.CommonMiddleware",
-    "django.middleware.csrf.CsrfViewMiddleware",
-    "django.contrib.auth.middleware.AuthenticationMiddleware",
+MIDDLEWARE.insert(
+    MIDDLEWARE.index("django.contrib.auth.middleware.AuthenticationMiddleware") + 1,
     "shibboleth.middleware.ShibbolethRemoteUserMiddleware",
-    "django.contrib.messages.middleware.MessageMiddleware",
-    "django.middleware.clickjacking.XFrameOptionsMiddleware",
-    "simple_history.middleware.HistoryRequestMiddleware",
 )
 
+DEBUG = False
+
 SHIBBOLETH_ATTRIBUTE_MAP = {
     "mail": (True, "username"),
     "givenName": (True, "first_name"),
@@ -37,4 +28,3 @@
 SOCIAL_AUTH_FACEBOOK_SCOPE = ["email"]
 SOCIAL_AUTH_USER_MODEL = "users.User"
 SOCIAL_AUTH_FACEBOOK_API_VERSION = "2.11"
-SUBMISSION_URL = "https://www.projekt-tomo.si"

web/web/settings/common.py

@@ -1,6 +1,23 @@
+"""
+Django settings for web project.
+
+Generated by 'django-admin startproject' using Django 4.1.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.1/ref/settings/
+"""
+
 import os
+from pathlib import Path
 
-BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Application definition
 
 INSTALLED_APPS = [
     "django.contrib.admin",
@@ -23,6 +40,7 @@
 ]
 
 MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.middleware.locale.LocaleMiddleware",
     "django.middleware.common.CommonMiddleware",
@@ -35,43 +53,72 @@
 
 ROOT_URLCONF = "web.urls"
 
-LANGUAGE_CODE = "en"
-
-TIME_ZONE = "UTC"
-
-USE_I18N = True
-
-USE_L10N = True
-
-USE_TZ = True
-
-AUTH_USER_MODEL = "users.User"
-
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
         "DIRS": [
-            os.path.join(BASE_DIR, "templates"),
+            BASE_DIR / ".." / "templates",
         ],
         "APP_DIRS": True,
         "OPTIONS": {
             "context_processors": [
-                # Insert your TEMPLATE_CONTEXT_PROCESSORS here or use this
-                # list if you haven't customized them:
-                "django.contrib.auth.context_processors.auth",
                 "django.template.context_processors.debug",
-                "django.template.context_processors.i18n",
-                "django.template.context_processors.media",
-                "django.template.context_processors.static",
-                "django.template.context_processors.tz",
-                "django.contrib.messages.context_processors.messages",
                 "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
             ],
         },
     },
 ]
 
-LOCALE_PATHS = (os.path.join(BASE_DIR, "locale"),)
+WSGI_APPLICATION = "web.wsgi.application"
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.1/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.1/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+
+
+AUTH_USER_MODEL = "users.User"
+
+LOCALE_PATHS = [BASE_DIR / "locale"]
 
 LOGGING = {
     "version": 1,
@@ -80,7 +127,7 @@
         "file": {
             "level": "WARNING",  # 'DEBUG'
             "class": "logging.FileHandler",
-            "filename": BASE_DIR + "/debug.log",
+            "filename": BASE_DIR / "debug.log",
         },
     },
     "loggers": {
@@ -92,4 +139,6 @@
     },
 }
 
-DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+SUBMISSION_URL = os.environ.get("SUBMISSION_URL", "http://127.0.0.1:8000")
+LOGIN_REDIRECT_URL = "/"
+STATIC_URL = "/static/"

web/web/settings/docker.py

@@ -6,8 +6,6 @@
 
 ALLOWED_HOSTS = [os.environ["ALLOWED_HOSTS"]]
 
-WSGI_APPLICATION = "web.wsgi.docker.application"
-
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.postgresql_psycopg2",
@@ -20,7 +18,3 @@
 }
 
 STATIC_ROOT = "/var/static/"
-STATIC_URL = "/static/"
-
-LOGIN_REDIRECT_URL = "/"
-SUBMISSION_URL = "http://127.0.0.1:8000"

web/web/settings/local.py

@@ -1,27 +1,25 @@
 from .common import *
 
-INSTALLED_APPS += [
-    "silk",
-]
+INSTALLED_APPS.append("silk")
 MIDDLEWARE.insert(0, "silk.middleware.SilkyMiddleware")
 
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
 SECRET_KEY = "0vb+-_-52phz@ii^cxr+mlgvmn6fctd+v5qpnv&k+-00#u-==0"
 
+# SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
 ALLOWED_HOSTS = []
 
-WSGI_APPLICATION = "web.wsgi.local.application"
+# Database
+# https://docs.djangoproject.com/en/4.1/ref/settings/#databases
 
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": "tomo.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
     }
 }
-
-STATIC_URL = "/static/"
-LOGIN_URL = "/accounts/login/"
-LOGOUT_URL = "/accounts/logout/"
-LOGIN_REDIRECT_URL = "/"
-SUBMISSION_URL = "http://127.0.0.1:8000"

web/web/wsgi/local.py web/web/wsgi.pyweb/web/wsgi/local.py renamed to web/web/wsgi.py

@@ -4,13 +4,13 @@
 It exposes the WSGI callable as a module-level variable named ``application``.
 
 For more information on this file, see
-https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/
+https://docs.djangoproject.com/en/4.1/howto/deployment/wsgi/
 """
 
 import os
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "web.settings.local")
-
 from django.core.wsgi import get_wsgi_application
 
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "web.settings.local")
+
 application = get_wsgi_application()