csfieldguide/config/settings/base.py
# -*- coding: utf-8 -*-
"""
Base Django settings for CS Field Guide project.
For more information on this file, see
https://docs.djangoproject.com/en/dev/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/dev/ref/settings/
"""
import environ
import os.path
import logging.config
# Add custom languages not provided by Django
import django.conf.locale
from django.conf import global_settings
from django.utils.translation import gettext_lazy as _
from utils.get_git_sha import get_git_sha
# cs-field-guide/csfieldguide/config/settings/base.py - 3 = csfieldguide/
ROOT_DIR = environ.Path(__file__) - 3
# Load operating system environment variables and then prepare to use them
env = environ.Env()
# APP CONFIGURATION
# ----------------------------------------------------------------------------
DJANGO_APPS = [
"corsheaders",
# Default Django apps:
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
"django.contrib.postgres",
# Useful template tags
"django.contrib.humanize",
]
THIRD_PARTY_APPS = [
"modeltranslation",
"bidiutils",
"svg",
"statici18n",
]
# Apps specific for this project go here.
LOCAL_APPS = [
"general.apps.GeneralConfig",
"chapters.apps.ChaptersConfig",
"curriculum_guides.apps.CurriculumGuidesConfig",
"appendices.apps.AppendicesConfig",
"interactives.apps.InteractivesConfig",
"search.apps.SearchConfig",
]
# See: https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
INSTALLED_APPS = DJANGO_APPS + LOCAL_APPS + THIRD_PARTY_APPS
# MIDDLEWARE CONFIGURATION
# ----------------------------------------------------------------------------
MIDDLEWARE = [
"corsheaders.middleware.CorsMiddleware",
"django.middleware.security.SecurityMiddleware",
"whitenoise.middleware.WhiteNoiseMiddleware",
"django.contrib.sessions.middleware.SessionMiddleware",
"django.middleware.locale.LocaleMiddleware",
"django.middleware.common.CommonMiddleware",
"django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
]
# DEBUG
# ----------------------------------------------------------------------------
# See: https://docs.djangoproject.com/en/dev/ref/settings/#debug
DEBUG = env.bool("DJANGO_DEBUG", False)
# FIXTURE CONFIGURATION
# ----------------------------------------------------------------------------
# See: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-FIXTURE_DIRS
FIXTURE_DIRS = (
str(ROOT_DIR.path("fixtures")),
)
# GENERAL CONFIGURATION
# ----------------------------------------------------------------------------
# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# In a Windows environment this must be set to your system time zone.
TIME_ZONE = "UTC"
# See: https://docs.djangoproject.com/en/dev/ref/settings/#language-code
LANGUAGE_CODE = "en"
INCONTEXT_L10N_PSEUDOLANGUAGE = "xx-lr"
INCONTEXT_L10N_PSEUDOLANGUAGE_BIDI = "yy-rl"
INCONTEXT_L10N_PSEUDOLANGUAGES = (
INCONTEXT_L10N_PSEUDOLANGUAGE,
INCONTEXT_L10N_PSEUDOLANGUAGE_BIDI
)
DEFAULT_LANGUAGES = (
("en", "English"),
("de", "Deutsche"),
("es", "Español"),
)
# Keep original values of languages for resource generation
LANGUAGES = DEFAULT_LANGUAGES
if env.bool("INCLUDE_INCONTEXT_L10N", False):
EXTRA_LANGUAGES = [
(INCONTEXT_L10N_PSEUDOLANGUAGE, "Translation mode"),
(INCONTEXT_L10N_PSEUDOLANGUAGE_BIDI, "Translation mode (Bi-directional)"),
]
EXTRA_LANG_INFO = {
INCONTEXT_L10N_PSEUDOLANGUAGE: {
"bidi": False,
"code": INCONTEXT_L10N_PSEUDOLANGUAGE,
"name": "Translation mode",
"name_local": _("Translation mode"),
},
INCONTEXT_L10N_PSEUDOLANGUAGE_BIDI: {
"bidi": True,
"code": INCONTEXT_L10N_PSEUDOLANGUAGE_BIDI,
"name": "Translation mode (Bi-directional)",
"name_local": _("Translation mode (Bi-directional)"),
}
}
django.conf.locale.LANG_INFO.update(EXTRA_LANG_INFO)
# Add new languages to the list of all django languages
global_settings.LANGUAGES = global_settings.LANGUAGES + EXTRA_LANGUAGES
global_settings.LANGUAGES_BIDI = (global_settings.LANGUAGES_BIDI +
[INCONTEXT_L10N_PSEUDOLANGUAGE_BIDI.split("-")[0]])
# Add new languages to the list of languages used for this project
LANGUAGES += tuple(EXTRA_LANGUAGES)
LANGUAGES_BIDI = global_settings.LANGUAGES_BIDI
# See: https://docs.djangoproject.com/en/dev/ref/settings/#site-id
SITE_ID = 1
# See: https://docs.djangoproject.com/en/dev/ref/settings/#use-i18n
USE_I18N = True
# See: https://docs.djangoproject.com/en/dev/ref/settings/#use-l10n
USE_L10N = True
# See: https://docs.djangoproject.com/en/dev/ref/settings/#use-tz
USE_TZ = True
# See: https://docs.djangoproject.com/en/dev/ref/settings/#locale-paths
LOCALE_PATHS = ["locale"]
# TEMPLATE CONFIGURATION
# ----------------------------------------------------------------------------
# See: https://docs.djangoproject.com/en/dev/ref/settings/#templates
TEMPLATES = [
{
# See: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-TEMPLATES-BACKEND
"BACKEND": "django.template.backends.django.DjangoTemplates",
# See: https://docs.djangoproject.com/en/dev/ref/settings/#template-dirs
"APP_DIRS": True,
"DIRS": [
str(ROOT_DIR.path("templates")),
],
"OPTIONS": {
# See: https://docs.djangoproject.com/en/dev/ref/settings/#template-debug
"debug": DEBUG,
# See: https://docs.djangoproject.com/en/dev/ref/settings/#template-context-processors
"context_processors": [
"django.template.context_processors.debug",
"django.template.context_processors.request",
"django.contrib.auth.context_processors.auth",
"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",
"config.context_processors.version_number.version_number",
"config.context_processors.deployed.deployed",
"config.context_processors.teacher_mode.teacher_mode",
"bidiutils.context_processors.bidi",
],
"libraries": {
"get_item": "config.templatetags.get_item",
"read_static_file": "config.templatetags.read_static_file",
"render_html_field": "config.templatetags.render_html_field",
"render_interactive_in_page": "config.templatetags.render_interactive_in_page",
"render_interactive_link": "config.templatetags.render_interactive_link",
"get_interactive_thumbnail": "config.templatetags.render_interactive_link",
"translate_url": "config.templatetags.translate_url",
"query_replace": "config.templatetags.query_replace",
},
},
},
]
# LOGGING
# ------------------------------------------------------------------------------
# Based off https://lincolnloop.com/blog/django-logging-right-way/
logging.config.dictConfig({
"version": 1,
"disable_existing_loggers": False,
"formatters": {
"console": {
"format": "%(asctime)s %(name)-20s %(levelname)-10s %(message)s",
},
},
"handlers": {
"console": {
"class": "logging.StreamHandler",
"formatter": "console",
},
},
"loggers": {
# Root logger
"": {
"level": env("LOG_LEVEL", default="INFO"),
"handlers": ["console", ],
},
"django": {
"handlers": ["console"],
"level": env("LOG_LEVEL", default="INFO"),
"propagate": False,
},
# Project specific logger
"csfieldguide": {
"level": env("LOG_LEVEL", default="INFO"),
"handlers": ["console", ],
# Required to avoid double logging with root logger
"propagate": False,
},
'gunicorn.error': {
"level": env("LOG_LEVEL", default="INFO"),
'handlers': ['console'],
'propagate': False,
},
'gunicorn.access': {
"level": env("LOG_LEVEL", default="INFO"),
'handlers': ['console'],
'propagate': False,
},
},
})
# STATIC FILE CONFIGURATION
# ------------------------------------------------------------------------------
# See: https://docs.djangoproject.com/en/dev/ref/settings/#static-root
STATIC_ROOT = os.path.join(str(ROOT_DIR.path("staticfiles")), "")
BUILD_ROOT = os.path.join(str(ROOT_DIR.path("build")), "")
# See: https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#std:setting-STATICFILES_DIRS
STATICFILES_DIRS = [
BUILD_ROOT,
]
# See: https://docs.djangoproject.com/en/dev/ref/settings/#static-url
STATIC_URL = "/static/"
# See: https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#staticfiles-finders
STATICFILES_FINDERS = [
"django.contrib.staticfiles.finders.FileSystemFinder",
"django.contrib.staticfiles.finders.AppDirectoriesFinder",
]
# MEDIA CONFIGURATION
# ------------------------------------------------------------------------------
# See: https://docs.djangoproject.com/en/dev/ref/settings/#media-root
MEDIA_ROOT = str(ROOT_DIR("media"))
# See: https://docs.djangoproject.com/en/dev/ref/settings/#media-url
MEDIA_URL = "/media/"
# URL Configuration
# ------------------------------------------------------------------------------
ROOT_URLCONF = "config.urls"
# See: https://docs.djangoproject.com/en/dev/ref/settings/#wsgi-application
WSGI_APPLICATION = "config.wsgi.application"
# PASSWORD VALIDATION
# https://docs.djangoproject.com/en/dev/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",
},
]
# OTHER SETTINGS
# ------------------------------------------------------------------------------
DEPLOYED = env.bool("DEPLOYED")
GIT_SHA = get_git_sha()
PRODUCTION_ENVIRONMENT = False
STAGING_ENVIRONMENT = False
APPENDICES_CONTENT_BASE_PATH = os.path.join(str(ROOT_DIR.path("appendices")), "content")
CHAPTERS_CONTENT_BASE_PATH = os.path.join(str(ROOT_DIR.path("chapters")), "content")
CURRICULUM_GUIDES_CONTENT_BASE_PATH = os.path.join(str(ROOT_DIR.path("curriculum_guides")), "content")
INTERACTIVES_CONTENT_BASE_PATH = os.path.join(str(ROOT_DIR.path("interactives")), "content")
INTERACTIVES_BASE_TEMPLATES_PATH = os.path.join("interactives", "base")
INTERACTIVES_LINK_TEMPLATE = "interactives/utils/interactive-link.html"
INTERACTIVES_THUMBNAIL_PATH = "img/interactives/thumbnails/{}/{}.png"
MODELTRANSLATION_CUSTOM_FIELDS = ("JSONField",)
CUSTOM_VERTO_TEMPLATES = os.path.join(str(ROOT_DIR.path("utils")), "custom_converter_templates", "")
STATICI18N_ROOT = BUILD_ROOT
SVG_DIRS = [os.path.join(str(ROOT_DIR.path("staticfiles")), "svg")]
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
X_FRAME_OPTIONS = "SAMEORIGIN"
CORS_ALLOWED_ORIGINS = [
"http://127.0.0.1:8000",
"http://localhost:8000",
"https://canterbury.ac.nz"
]