add default_settings so users don't have to update their settings when new mandatory apps or middleware is used.

tom_common/default_settings.py

@@ -0,0 +1,55 @@
+"""
+Default settings for TOM Toolkits.
+
+This sets all of the mandatory apps and middleware as defaults
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.2/ref/settings/
+"""
+
+TOMTOOKIT_INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'django.contrib.sites',
+    'django_extensions',
+    'django_tasks',
+    'django_tasks.backends.database',
+    'guardian',
+    'tom_common',
+    'django_comments',
+    'bootstrap4',
+    'crispy_bootstrap4',
+    'crispy_forms',
+    'rest_framework',
+    'rest_framework.authtoken',
+    'django_filters',
+    'django_tables2',
+    'django_gravatar',
+    'django_htmx',
+    'tom_targets',
+    'tom_alerts',
+    'tom_catalogs',
+    'tom_observations',
+    'tom_dataproducts',
+]
+
+TOMTOOKIT_MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'django_htmx.middleware.HtmxMiddleware',
+    'tom_common.middleware.Raise403Middleware',
+    'tom_common.middleware.ExternalServiceMiddleware',
+    'tom_common.middleware.AuthStrategyMiddleware',
+]

tom_setup/management/commands/tom_setup.py

@@ -1,6 +1,7 @@
 from django.core.management.base import BaseCommand
 import sys
 import os
+import django
 from django.conf import settings
 from django.template.loader import get_template
 from django.core.management import call_command
@@ -280,6 +281,7 @@ def complete(self):
     def handle(self, *args, **options):
         self.context['CREATE_DATE'] = timezone.now()
         self.context['PROJECT_NAME'] = os.path.basename(BASE_DIR)
+        self.context['DJANGO_VERSION'] = django.get_version()
         self.welcome_banner()
         self.check_python()
         self.create_custom_code_app()

tom_setup/templates/tom_setup/settings.tmpl

@@ -1,26 +1,29 @@
 """
 Django settings for your TOM project.
 
-Originally generated by 'django-admin startproject' using Django 2.1.1.
+Originally generated by 'django-admin startproject' using Django {{ DJANGO_VERSION }}.
 Generated by ./manage.py tom_setup on {{ CREATE_DATE }}
 
 For more information on this file, see
-https://docs.djangoproject.com/en/4.2/topics/settings/
+https://docs.djangoproject.com/en/stable/topics/settings/
 
 For the full list of settings and their values, see
-https://docs.djangoproject.com/en/4.2/ref/settings/
+https://docs.djangoproject.com/en/stable/ref/settings/
+and
+https://tom-toolkit.readthedocs.io/en/stable/common/customsettings.html
 """
 import logging.config
 import os
 import tempfile
+from tom_common.default_settings import *
 
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
 
 # Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
+# See https://docs.djangoproject.com/en/stable/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
 SECRET_KEY = '{{ SECRET_KEY }}'
@@ -38,51 +41,13 @@ TOM_NAME = '{{ PROJECT_NAME }}'
 # Use built-in css theme to change the look of your TOM. (Valid themes = [Dark,])
 # CSS_THEME = 'Dark'
 
-INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
-    'django.contrib.sites',
-    'django_extensions',
-    'django_tasks',
-    'django_tasks.backends.database',
-    'guardian',
-    'tom_common',
-    'django_comments',
-    'bootstrap4',
-    'crispy_bootstrap4',
-    'crispy_forms',
-    'rest_framework',
-    'rest_framework.authtoken',
-    'django_filters',
-    'django_tables2',
-    'django_gravatar',
-    'django_htmx',
-    'tom_targets',
-    'tom_alerts',
-    'tom_catalogs',
-    'tom_observations',
-    'tom_dataproducts',
+INSTALLED_APPS = TOMTOOKIT_INSTALLED_APPS + [
     '{{ CUSTOM_CODE_APP_NAME }}',
 ]
 
 SITE_ID = 1
 
-MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
-    'django_htmx.middleware.HtmxMiddleware',
-    'tom_common.middleware.Raise403Middleware',
-    'tom_common.middleware.ExternalServiceMiddleware',
-    'tom_common.middleware.AuthStrategyMiddleware',
+MIDDLEWARE = TOMTOOKIT_MIDDLEWARE + [
 ]
 
 ROOT_URLCONF = '{{ PROJECT_NAME }}.urls'