Update project template (#604)

Basic template:
* Add `CoderedEventPage` and `CoderedLocationPage` (and associated
models) to the default template. This exposes those models to new
projects without having to write additional code.
* Add a pyproject.toml to prevent Django from trying to blacken
migrations when starting a new project. At some point Django started
doing this and it can potentially cause a huge slowdown.

Sass template (renamed to "pro"):
* Same changes from basic template
* This will be designated as the "professional" template for use in
real-world projects. Therefore, this template provides a full suite of
pre-configured developer tooling.
* Provide `ruff` with configuration.
* Provide `mypy` with configuration.
* Provide `pytest` with configuration.
* Provides custom User, Image, and Document models by default.

Related changes:
* To further avoid lag from the Django template renderer, we now
explicitly define files in project_template which are actually
templates.
* Add pipeline test matrix that checks both basic and pro templates.

Author: vsalvino

azure-pipelines.yml

@@ -34,18 +34,27 @@ stages:
         py3.8_wag5.0:
           PYTHON_VERSION: '3.8'
           WAGTAIL_VERSION: '5.0.*'
+          TEMPLATE: 'basic'
         py3.9_wag5.0:
           PYTHON_VERSION: '3.9'
           WAGTAIL_VERSION: '5.0.*'
+          TEMPLATE: 'basic'
         py3.10_wag5.0:
           PYTHON_VERSION: '3.10'
           WAGTAIL_VERSION: '5.0.*'
+          TEMPLATE: 'basic'
         py3.11_wag5.1:
           PYTHON_VERSION: '3.11'
           WAGTAIL_VERSION: '5.1.*'
-        py3.12_wag5.2:
+          TEMPLATE: 'basic'
+        py3.12_wag5.2_basic:
           PYTHON_VERSION: '3.12'
           WAGTAIL_VERSION: '5.2.*'
+          TEMPLATE: 'basic'
+        py3.12_wag5.2_pro:
+          PYTHON_VERSION: '3.12'
+          WAGTAIL_VERSION: '5.2.*'
+          TEMPLATE: 'pro'
 
     steps:
     - task: UsePythonVersion@0
@@ -57,9 +66,16 @@ stages:
     - script: python -m pip install -r requirements-ci.txt wagtail==$(WAGTAIL_VERSION)
       displayName: 'CR-QC: Install coderedcms from local repo'
 
-    - script: coderedcms start testproject
+    - script: coderedcms start testproject --template $(TEMPLATE)
       displayName: 'CR-QC: Create starter project from template'
 
+    - script: |
+        cd testproject/
+        touch requirements-dev.txt
+        python -m pip install -r requirements-dev.txt
+        python manage.py makemigrations --check
+      displayName: 'CR-QC: Check migrations'
+
     - pwsh: ./ci/run-tests.ps1
       displayName: 'CR-QC: Run unit tests'
 
@@ -101,14 +117,6 @@ stages:
     - pwsh: ./ci/spellcheck.ps1
       displayName: 'CR-QC: Spelling'
 
-    - script: coderedcms start testproject
-      displayName: 'CR-QC: Generate a test project'
-
-    - script: |
-        cd testproject/
-        python manage.py makemigrations --check
-      displayName: 'CR-QC: Check migrations'
-
     - script: black --check .
       displayName: 'CR-QC: Black'
 

coderedcms/bin/coderedcms.py

@@ -61,9 +61,17 @@ def handle(self, **options):
         if os.path.isdir(template_path):
             options["template"] = template_path
 
+        # Assume all files are NOT Django templates.
+        options["extensions"] = ["toml"]
         # Treat these files as Django templates to render the boilerplate.
-        options["extensions"] = ["py", "md", "txt"]
-        options["files"] = ["Dockerfile"]
+        options["files"] = [
+            "0002_initial_data.py",
+            "base.py",
+            "manage.py",
+            "README.md",
+            "requirements.txt",
+            "wsgi.py",
+        ]
 
         # Set options
         message = "Creating a Wagtail CRX project called %(project_name)s"

coderedcms/project_template/basic/.gitignore

@@ -1,4 +1,4 @@
-# Created by https://www.gitignore.io, modified for use with CodeRed CMS.
+# Created by https://www.gitignore.io, modified for use with Wagtail CRX.
 
 #######################################
 ### Editors
@@ -197,7 +197,7 @@ tags
 *.pyc
 __pycache__/
 local_settings.py
-db.sqlite3
+*.sqlite3
 
 # If your build process includes running collectstatic, then you probably don't need or want to include staticfiles/
 # in your Git repository. Update and uncomment the following line accordingly.
@@ -315,6 +315,15 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# Ruff
+.ruff_cache/
+
+
+
+#######################################
+### Operating Systems
+#######################################
+
 
 ### OSX ###
 
@@ -346,12 +355,6 @@ Temporary Items
 .apdisk
 
 
-
-#######################################
-### Operating Systems
-#######################################
-
-
 ### Windows ###
 
 # Windows thumbnail cache files
@@ -381,19 +384,18 @@ $RECYCLE.BIN/
 
 
 #######################################
-### CodeRed CMS
+### Wagtail CRX
 #######################################
 
 
-#### CodeRed CMS defaults ###
-
 # Cache
 cache/
 
 # File uploads from forms
-protected/
+/protected/
+
+# Media files
+/media/
 
-# if you want to store original uploaded media files in version control,
-# replace "media/" with "media/images/"
-media/
-#media/images/
+# Collected static files
+/static/

coderedcms/project_template/basic/manage.py

@@ -2,9 +2,11 @@
 import os
 import sys
 
+
 if __name__ == "__main__":
     os.environ.setdefault(
-        "DJANGO_SETTINGS_MODULE", "{{ project_name }}.settings.dev"
+        "DJANGO_SETTINGS_MODULE",
+        "{{ project_name }}.settings.dev",
     )
 
     from django.core.management import execute_from_command_line

coderedcms/project_template/basic/project_name/settings/base.py

@@ -10,12 +10,11 @@
 https://docs.djangoproject.com/en/{{ docs_version }}/ref/settings/
 """
 
-# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
-import os
-from django.utils.translation import gettext_lazy as _
+from pathlib import Path
 
-PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-BASE_DIR = os.path.dirname(PROJECT_DIR)
+
+# Build paths inside the project like this: BASE_DIR / "subdir".
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
 
 
 # Quick-start development settings - unsuitable for production
@@ -70,8 +69,6 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "django.middleware.security.SecurityMiddleware",
-    #  Error reporting. Uncomment this to receive emails when a 404 is triggered.
-    # 'django.middleware.common.BrokenLinkEmailsMiddleware',
     # CMS functionality
     "wagtail.contrib.redirects.middleware.RedirectMiddleware",
     # Fetch from cache. Must be LAST.
@@ -105,7 +102,7 @@
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
+        "NAME": BASE_DIR / "db.sqlite3",
     }
 }
 
@@ -128,17 +125,15 @@
     },
 ]
 
+
 # Internationalization
 # https://docs.djangoproject.com/en/{{ docs_version }}/topics/i18n/
 
-# To add or change language of the project, modify the list below.
 LANGUAGE_CODE = "en-us"
 
-LANGUAGES = [("en-us", _("English"))]
-
 TIME_ZONE = "America/New_York"
 
-USE_I18N = True
+USE_I18N = False
 
 USE_TZ = True
 
@@ -151,10 +146,10 @@
     "django.contrib.staticfiles.finders.AppDirectoriesFinder",
 ]
 
-STATIC_ROOT = os.path.join(BASE_DIR, "static")
+STATIC_ROOT = BASE_DIR / "static"
 STATIC_URL = "/static/"
 
-MEDIA_ROOT = os.path.join(BASE_DIR, "media")
+MEDIA_ROOT = BASE_DIR / "media"
 MEDIA_URL = "/media/"
 
 
@@ -170,11 +165,6 @@
 
 WAGTAIL_ENABLE_UPDATE_CHECK = False
 
-WAGTAILSEARCH_BACKENDS = {
-    "default": {
-        "BACKEND": "wagtail.search.backends.database",
-    }
-}
 
 # Base URL to use when referring to full URLs within the Wagtail admin backend -
 # e.g. in notification emails. Don't include '/admin' or a trailing slash

coderedcms/project_template/basic/project_name/settings/prod.py

@@ -32,7 +32,7 @@
 CACHES = {
     "default": {
         "BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
-        "LOCATION": os.path.join(BASE_DIR, "cache"),  # noqa
+        "LOCATION": BASE_DIR / "cache",  # noqa
         "KEY_PREFIX": "coderedcms",
         "TIMEOUT": 14400,  # in seconds
     }

coderedcms/project_template/basic/project_name/urls.py

@@ -1,10 +1,12 @@
-from django.conf import settings
-from django.urls import include, path
-from django.contrib import admin
-from wagtail.documents import urls as wagtaildocs_urls
 from coderedcms import admin_urls as crx_admin_urls
 from coderedcms import search_urls as crx_search_urls
 from coderedcms import urls as crx_urls
+from django.conf import settings
+from django.contrib import admin
+from django.urls import include
+from django.urls import path
+from wagtail.documents import urls as wagtaildocs_urls
+
 
 urlpatterns = [
     # Admin
@@ -24,10 +26,11 @@
 ]
 
 
+# fmt: off
 if settings.DEBUG:
     from django.conf.urls.static import static
-    from django.contrib.staticfiles.urls import staticfiles_urlpatterns
 
     # Serve static and media files from development server
-    urlpatterns += staticfiles_urlpatterns()
-    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
+    urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)  # type: ignore
+    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)  # type: ignore
+# fmt: on

coderedcms/project_template/basic/project_name/wsgi.py

@@ -11,8 +11,10 @@
 
 from django.core.wsgi import get_wsgi_application
 
+
 os.environ.setdefault(
-    "DJANGO_SETTINGS_MODULE", "{{ project_name }}.settings.dev"
+    "DJANGO_SETTINGS_MODULE",
+    "{{ project_name }}.settings.dev",
 )
 
 application = get_wsgi_application()

coderedcms/project_template/basic/pyproject.toml

@@ -0,0 +1,33 @@
+[tool.black]
+line-length = 80
+extend-exclude = ["migrations"]
+
+[tool.django-stubs]
+django_settings_module = "{{ project_name }}.settings.dev"
+
+[tool.mypy]
+ignore_missing_imports = true
+plugins = ["mypy_django_plugin.main"]
+exclude = [
+    '^\..*',
+    'migrations',
+    'node_modules',
+    'venv',
+]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "{{ project_name }}.settings.dev"
+addopts = "--cov --cov-report html"
+python_files = "tests.py test_*.py"
+
+[tool.ruff]
+extend-exclude = ["migrations"]
+line-length = 80
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.ruff.lint.isort]
+case-sensitive = false
+force-single-line = true
+lines-after-imports = 2