Refactor site settings to set up static export of demo site

Author: thibaudcolas

.gitignore

@@ -62,7 +62,6 @@ coverage.xml
 *.pot
 # Django stuff:
 *.log
-local_settings.py
 # Flask instance folder
 instance/
 # Scrapy stuff:

CONTRIBUTING.md

@@ -21,9 +21,9 @@ Then you can install the dependencies and run the test app:
 ```sh
 poetry install
 # Start the server for testing:
-poetry run django-admin runserver --settings=tests.settings --pythonpath=.
+poetry run django-admin runserver --settings=tests.settings.dev --pythonpath=.
 # Or to try out the render_patterns command:
-poetry run django-admin render_patterns --settings=tests.settings --pythonpath=. --dry-run --verbosity 2
+poetry run django-admin render_patterns --settings=tests.settings.dev --pythonpath=. --dry-run --verbosity 2
 ```
 
 ### Run a local build with docker

Dockerfile

@@ -9,7 +9,7 @@ RUN useradd dpl && \
 COPY pyproject.toml ./
 RUN poetry install --no-root
 
-ENV DJANGO_SETTINGS_MODULE=tests.settings \
+ENV DJANGO_SETTINGS_MODULE=tests.settings.dev \
     PYTHONPATH=.
 
 USER dpl

runtests.py

@@ -22,7 +22,7 @@
     cov.start()
 
     # Django setup
-    os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings'
+    os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings.dev'
     django.setup()
 
     # Test runner setup

tests/settings/__init__.py

@@ -0,0 +1 @@
+from .base import *  # noqa

tests/settings.py renamed to tests/settings/base.py

@@ -0,0 +1,5 @@
+from .base import *  # noqa
+
+# Serve the site as if it was hosted at the `/django-pattern-library/` sub-path
+STATIC_URL = '/django-pattern-library/demo/static/'
+GITHUB_PAGES_EXPORT = True

tests/settings/dev.py

@@ -1,7 +1,13 @@
+from django.conf import settings
 from django.conf.urls import include, url
 
 from pattern_library import urls as pattern_library_urls
 
-urlpatterns = [
-    url(r'^pattern-library/', include(pattern_library_urls)),
-]
+if settings.GITHUB_PAGES_EXPORT:
+    urlpatterns = [
+        url(r'^django-pattern-library/demo/pattern-library/', include(pattern_library_urls)),
+    ]
+else:
+    urlpatterns = [
+        url(r'^pattern-library/', include(pattern_library_urls)),
+    ]

tests/settings/production.py

@@ -9,7 +9,7 @@ install_command =
     ./tox_install.sh {packages}
 commands =
     poetry run ./runtests.py
-    poetry run django-admin render_patterns --settings=tests.settings --pythonpath=. --dry-run
+    poetry run django-admin render_patterns --settings=tests.settings.dev --pythonpath=. --dry-run
 deps =
     dj22: Django>=2.2,<2.3
     dj30: Django>=3.0,<3.1