""" Django settings for pydis_site project. Generated by 'django-admin startproject' using Django 2.1. For more information on this file, see https://docs.djangoproject.com/en/2.1/topics/settings/ For the full list of settings and their values, see https://docs.djangoproject.com/en/2.1/ref/settings/ """ import logging import os import secrets import sys import warnings from pathlib import Path from socket import gethostbyname, gethostname import environ import sentry_sdk from sentry_sdk.integrations.logging import LoggingIntegration from sentry_sdk.integrations.django import DjangoIntegration env = environ.Env( DEBUG=(bool, False), SITE_DSN=(str, ""), BUILDING_DOCKER=(bool, False), STATIC_BUILD=(bool, False), GIT_SHA=(str, 'development'), TIMEOUT_PERIOD=(int, 5), GITHUB_TOKEN=(str, None), GITHUB_APP_ID=(str, None), GITHUB_APP_KEY=(str, None), ) GIT_SHA = env("GIT_SHA") GITHUB_API = "https://api.github.com" GITHUB_TOKEN = env("GITHUB_TOKEN") GITHUB_APP_ID = env("GITHUB_APP_ID") GITHUB_APP_KEY = env("GITHUB_APP_KEY") GITHUB_TIMESTAMP_FORMAT = "%Y-%m-%dT%H:%M:%SZ" """The datetime string format GitHub uses.""" STATIC_BUILD: bool = env("STATIC_BUILD") if GITHUB_APP_KEY and (key_file := Path(GITHUB_APP_KEY)).is_file(): # Allow the OAuth key to be loaded from a file GITHUB_APP_KEY = key_file.read_text(encoding="utf-8") if not STATIC_BUILD: sentry_sdk.init( dsn=env('SITE_DSN'), integrations=[DjangoIntegration(), LoggingIntegration(level=logging.DEBUG, event_level=logging.ERROR)], send_default_pii=True, release=f"site@{GIT_SHA}", profiles_sample_rate=1.0, traces_sample_rate=1.0, enable_db_query_source=True, db_query_source_threshold_ms=100, # Queries slower that 100ms will include the source in the event ) # Build paths inside the project like this: os.path.join(BASE_DIR, ...) BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) DEBUG = env('DEBUG') # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/2.1/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! if DEBUG: ALLOWED_HOSTS = env.list('ALLOWED_HOSTS', default=['*']) SECRET_KEY = "yellow polkadot bikini" # noqa: S105 # Prevent verbose warnings emitted when passing a non-timezone aware # datetime object to the database, whilst we have time zone support # active. See the Django documentation for more details: # https://docs.djangoproject.com/en/dev/topics/i18n/timezones/ warnings.filterwarnings( 'error', r"DateTimeField .* received a naive datetime", RuntimeWarning, r'django\.db\.models\.fields', ) elif 'CI' in os.environ: ALLOWED_HOSTS = ['*'] SECRET_KEY = secrets.token_urlsafe(32) # See above. We run with `CI=true`, but debug unset in GitHub Actions, # so we also want to filter it there. warnings.filterwarnings( 'error', r"DateTimeField .* received a naive datetime", RuntimeWarning, r'django\.db\.models\.fields', ) else: ALLOWED_HOSTS = env.list( 'ALLOWED_HOSTS', default=[ 'www.pythondiscord.com', 'pythondiscord.com', gethostname(), gethostbyname(gethostname()), 'site.web.svc.cluster.local', ], ) SECRET_KEY = env('SECRET_KEY') # Application definition NON_STATIC_APPS = [ 'pydis_site.apps.api', 'pydis_site.apps.staff', ] if not STATIC_BUILD else [] INSTALLED_APPS = [ *NON_STATIC_APPS, 'pydis_site.apps.home', 'pydis_site.apps.timeline', 'pydis_site.apps.resources', 'pydis_site.apps.content', 'pydis_site.apps.events', 'pydis_site.apps.redirect', 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.sites', 'django.contrib.staticfiles', 'django_filters', 'django_simple_bulma', 'rest_framework', 'rest_framework.authtoken', 'django_distill', ] if not env("BUILDING_DOCKER"): INSTALLED_APPS.append("django_prometheus") if STATIC_BUILD: # The only middleware required during static builds MIDDLEWARE = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', ] else: # Ensure that Prometheus middlewares are first and last here. MIDDLEWARE = [ 'django_prometheus.middleware.PrometheusBeforeMiddleware', 'django.middleware.security.SecurityMiddleware', 'whitenoise.middleware.WhiteNoiseMiddleware', '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_prometheus.middleware.PrometheusAfterMiddleware' ] ROOT_URLCONF = 'pydis_site.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [os.path.join(BASE_DIR, 'pydis_site', 'templates')], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', "pydis_site.context_processors.git_sha_processor" ], }, }, ] WSGI_APPLICATION = 'pydis_site.wsgi.application' # Database # https://docs.djangoproject.com/en/2.1/ref/settings/#databases DATABASES = { 'default': env.db(engine="django_prometheus.db.backends.postgresql"), 'metricity': env.db('METRICITY_DB_URL', engine="django_prometheus.db.backends.postgresql"), } if not STATIC_BUILD else {} # Password validation # https://docs.djangoproject.com/en/2.1/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', }, ] # Internationalization # https://docs.djangoproject.com/en/2.1/topics/i18n/ LANGUAGE_CODE = 'en-us' TIME_ZONE = 'UTC' USE_I18N = True USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/2.1/howto/static-files/ STATIC_URL = '/static/' STATICFILES_DIRS = [os.path.join(BASE_DIR, 'pydis_site', 'static')] STATIC_ROOT = env('STATIC_ROOT', default='/app/staticfiles') STATICFILES_FINDERS = [ 'django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder', 'django_simple_bulma.finders.SimpleBulmaFinder', ] if DEBUG: PARENT_HOST = env('PARENT_HOST', default='pythondiscord.local:8000') if ":" in PARENT_HOST: ALLOWED_HOSTS.append(PARENT_HOST.split(":", 1)[0]) else: ALLOWED_HOSTS.append(PARENT_HOST) else: PARENT_HOST = env('PARENT_HOST', default='pythondiscord.com') # Django Model Configuration DEFAULT_AUTO_FIELD = "django.db.models.AutoField" # Django REST framework # https://www.django-rest-framework.org REST_FRAMEWORK = { 'DEFAULT_AUTHENTICATION_CLASSES': ( 'rest_framework.authentication.TokenAuthentication', ), 'DEFAULT_PERMISSION_CLASSES': ( 'rest_framework.permissions.DjangoModelPermissions', ), 'TEST_REQUEST_DEFAULT_FORMAT': 'json' } # Logging # https://docs.djangoproject.com/en/2.1/topics/logging/ LOGGING = { 'version': 1, 'disable_existing_loggers': False, 'formatters': { 'verbose': { 'format': ( '%(asctime)s | %(process)d:%(thread)d | %(module)s | %(levelname)-8s | %(message)s' ) } }, 'handlers': { 'console': { 'class': 'logging.StreamHandler' } }, 'loggers': { 'django': { 'handlers': ['console'], 'propagate': True, 'level': env( 'LOG_LEVEL', default=( # If there is no explicit `LOG_LEVEL` set, # use `DEBUG` if we're running in debug mode but not # testing. Use `ERROR` if we're running tests, else # default to using `WARN`. 'INFO' if DEBUG and 'test' not in sys.argv else ( 'ERROR' if 'test' in sys.argv else 'WARN' ) ) ) } } } # Custom settings for django-simple-bulma BULMA_SETTINGS = { # NOTE: Due to limitations with Bulma + CSS, it is not possible to # reference these color variables in our custom CSS files. When changing # colors here, please do a project-wise grep and make sure other places # that uses the old color is updated as appropriate. "variables": { "primary": "#7289DA", # PyDis blurple "green": "#32ac66", # Colour picked after Discord discussion "turquoise": "#7289DA", # Blurple, because Bulma uses this regardless of `primary` above "blue": "#2482c1", # Colour picked after Discord discussion "cyan": "#2482c1", # Colour picked after Discord discussion (matches the blue) "purple": "#aa55e4", # Apparently unused, but changed for consistency "red": "#d63852", # Colour picked after Discord discussion "link": "$primary", "dimensions": "16 24 32 48 64 96 128 256 512", # Possible image dimensions "navbar-height": "4.75rem", "footer-padding": "1rem 1.5rem 1rem", "tooltip-max-width": "30rem", }, "dark_variables": { "primary": "#5365A4", # A darker PyDis blurple "warning": "#4B4636", "warning-invert": "#FFFFFF", "warning-light": "#3B3B36", "primary-dark": "#EFF1FB", # Bulma's primary-light "primary-light": "#2B3660", "success-dark": "#EFFAF5", # Bulma's success-light "success-light": "#214133", "success": "#31815D", "danger-dark": "#FEECF0", # Bulma's danger-light "danger-light": "#4C1822", "info-dark": "#EFF5FB", # Bulma's info-light "info-light": "#254056", "body-background-color": "#252629", # These black and white colors are flipped so that when using # has-background-white class for example, a white background is used in # light mode whereas a dark background is applied in dark mode. "white": "#2C2F33", "white-bis": "#23272A ", "white-ter": "#36393F", "light": "$white", "black": "#F7F7F7", "black-bis": "#F2F2F2", "black-ter": "#E6E6E6", "dark": "$black", "grey": "#AFAFAF", "grey-darker": "#303032", "text": "#F4F4F4", "text-light": "#F7F7F7", "text-strong": "#FEFEFE", "link": "#99B0FF", # A brighter PyDis blurple "link-hover": "#FFFFFF", "link-focus": "$link-hover", "link-active": "$link-hover", "code": "#FF7990", # Adjusted to 4.5 contrast ratio per WCAG Level AA "code-background": "#464951", # A graduation lighter than the default for light theme # Same as bulma, adjusted for dark mode "shadow": "0 0.5em 1em -0.125em rgba(0, 0, 0, 0.3), 0 0px 0 1px rgba(0, 0, 0, 0.13)", "border": "#4E4F51", "border-light": "#313233", # Use the same sizes "dimensions": "16 24 32 48 64 96 128 256 512", "navbar-height": "4.75rem", "footer-padding": "1rem 1.5rem 1rem", "tooltip-max-width": "30rem", }, "extensions": [ "bulma-dropdown", "bulma-navbar-burger", ], } # Information about site repository SITE_REPOSITORY_OWNER = "python-discord" SITE_REPOSITORY_NAME = "site" SITE_REPOSITORY_BRANCH = "master" # Path for events pages EVENTS_PAGES_PATH = Path(BASE_DIR, "pydis_site", "templates", "events", "pages") # Path for content pages CONTENT_PAGES_PATH = Path(BASE_DIR, "pydis_site", "apps", "content", "resources") # Path for redirection links REDIRECTIONS_PATH = Path(BASE_DIR, "pydis_site", "apps", "redirect", "redirects.yaml") # How long to wait for synchronous requests before timing out TIMEOUT_PERIOD = env("TIMEOUT_PERIOD") # Source files url for 'Edit on GitHub' link on content articles CONTENT_SRC_URL = ( "https://github.com/python-discord/site/tree/main/pydis_site/apps/content/resources/" )