Adds Django Distill To Project

Adds django-distill to dependencies, and lays the basic groundwork to
start building static routes. Adds a poetry task to help with testing.

4 files changed, 65 insertions, 6 deletions

diff --git a/manage.py b/manage.py
index 578f4748..357134ec 100755
--- a/manage.py
+++ b/manage.py
@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 import os
+import platform
 import sys
+from pathlib import Path
 
 import django
 from django.contrib.auth import get_user_model
@@ -147,6 +149,22 @@ class SiteManager:
         gunicorn.app.wsgiapp.run()
 
 
+def clean_up_static_files(build_folder: Path) -> None:
+    """Recursively loop over the build directory and fix links."""
+    for file in build_folder.iterdir():
+        if file.is_dir():
+            clean_up_static_files(file)
+        elif file.name.endswith(".html"):
+            # Fix parent host url
+            new = file.read_text(encoding="utf-8").replace(f"//{os.getenv('PARENT_HOST')}", "")
+
+            # Fix windows paths if on windows
+            if platform.system() == "Windows":
+                new = new.replace("%5C", "/")
+
+            file.write_text(new, encoding="utf-8")
+
+
 def main() -> None:
     """Entry point for Django management script."""
     # Use the custom site manager for launching the server
@@ -155,8 +173,21 @@ def main() -> None:
 
     # Pass any others directly to standard management commands
     else:
+        if _static_build := "distill" in sys.argv[1]:
+            # Build a static version of the site with no databases and API support
+            os.environ["STATIC_BUILD"] = "True"
+            if not os.getenv("PARENT_HOST"):
+                os.environ["PARENT_HOST"] = "REPLACE_THIS.HOST"
+
         execute_from_command_line(sys.argv)
 
+        if _static_build:
+            # Clean up parent host in generated files
+            for arg in sys.argv[2:]:
+                if not arg.startswith("-"):
+                    clean_up_static_files(Path(arg))
+                    break
+
 
 if __name__ == '__main__':
     main()
diff --git a/poetry.lock b/poetry.lock
index c6724cfc..eac58fdb 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -138,6 +138,18 @@ argon2 = ["argon2-cffi (>=16.1.0)"]
 bcrypt = ["bcrypt"]
 
 [[package]]
+name = "django-distill"
+version = "2.9.0"
+description = "Static site renderer and publisher for Django."
+category = "main"
+optional = false
+python-versions = "*"
+
+[package.dependencies]
+django = "*"
+requests = "*"
+
+[[package]]
 name = "django-environ"
 version = "0.4.5"
 description = "Django-environ allows you to utilize 12factor inspired environment variables to configure your Django application."
@@ -757,7 +769,7 @@ brotli = ["brotli"]
 [metadata]
 lock-version = "1.1"
 python-versions = "3.9.*"
-content-hash = "ed7da8dbc905d4f2c47e01301b49c4aed0083bee269da0ee5ebcc3abee4ab1a0"
+content-hash = "9f0c069c14e2dbff63d58474702693f0c02b8cfd30e5af38303975a73b71bcfd"
 
 [metadata.files]
 asgiref = [
@@ -858,6 +870,9 @@ django = [
     {file = "Django-3.0.14-py3-none-any.whl", hash = "sha256:9bc7aa619ed878fedba62ce139abe663a147dccfd20e907725ec11e02a1ca225"},
     {file = "Django-3.0.14.tar.gz", hash = "sha256:d58d8394036db75a81896037d757357e79406e8f68816c3e8a28721c1d9d4c11"},
 ]
+django-distill = [
+    {file = "django-distill-2.9.0.tar.gz", hash = "sha256:08f31dcde2e79e73c0bc4f36941830603a811cc89472be11f79f14affb460d84"},
+]
 django-environ = [
     {file = "django-environ-0.4.5.tar.gz", hash = "sha256:6c9d87660142608f63ec7d5ce5564c49b603ea8ff25da595fd6098f6dc82afde"},
     {file = "django_environ-0.4.5-py2.py3-none-any.whl", hash = "sha256:c57b3c11ec1f319d9474e3e5a79134f40174b17c7cc024bbb2fad84646b120c4"},
diff --git a/pydis_site/settings.py b/pydis_site/settings.py
index d7b87f33..d38c298b 100644
--- a/pydis_site/settings.py
+++ b/pydis_site/settings.py
@@ -25,7 +25,8 @@ from pydis_site.constants import GIT_SHA
 env = environ.Env(
     DEBUG=(bool, False),
     SITE_DSN=(str, ""),
-    BUILDING_DOCKER=(bool, False)
+    BUILDING_DOCKER=(bool, False),
+    STATIC_BUILD=(bool, False),
 )
 
 sentry_sdk.init(
@@ -65,10 +66,14 @@ else:
     SECRET_KEY = env('SECRET_KEY')
 
 # Application definition
-INSTALLED_APPS = [
+NON_STATIC_APPS = [
     'pydis_site.apps.api',
-    'pydis_site.apps.home',
     'pydis_site.apps.staff',
+] if not env("STATIC_BUILD") else []
+
+INSTALLED_APPS = [
+    *NON_STATIC_APPS,
+    'pydis_site.apps.home',
     'pydis_site.apps.resources',
     'pydis_site.apps.content',
     'pydis_site.apps.events',
@@ -86,14 +91,20 @@ INSTALLED_APPS = [
     'django_simple_bulma',
     'rest_framework',
     'rest_framework.authtoken',
+
+    'django_distill',
 ]
 
 if not env("BUILDING_DOCKER"):
     INSTALLED_APPS.append("django_prometheus")
 
+NON_STATIC_MIDDLEWARE = [
+    'django_prometheus.middleware.PrometheusBeforeMiddleware',
+] if not env("STATIC_BUILD") else []
+
 # Ensure that Prometheus middlewares are first and last here.
 MIDDLEWARE = [
-    'django_prometheus.middleware.PrometheusBeforeMiddleware',
+    *NON_STATIC_MIDDLEWARE,
 
     'django.middleware.security.SecurityMiddleware',
     'whitenoise.middleware.WhiteNoiseMiddleware',
@@ -134,7 +145,7 @@ WSGI_APPLICATION = 'pydis_site.wsgi.application'
 DATABASES = {
     'default': env.db(),
     'metricity': env.db('METRICITY_DB_URL'),
-}
+} if not env("STATIC_BUILD") else {}
 
 # Password validation
 # https://docs.djangoproject.com/en/2.1/ref/settings/#auth-password-validators
diff --git a/pyproject.toml b/pyproject.toml
index d0beb632..2f1322e3 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -21,6 +21,7 @@ sentry-sdk = "~=0.19"
 markdown = "~=3.3.4"
 python-frontmatter = "~=1.0"
 django-prometheus = "~=2.1"
+django-distill = "~=2.9.0"
 
 [tool.poetry.dev-dependencies]
 coverage = "~=5.0"
@@ -53,3 +54,4 @@ test = "coverage run manage.py test"
 report = "coverage report -m"
 lint = "pre-commit run --all-files"
 precommit = "pre-commit install"
+static = "python mange.py distill-local build --traceback --force"