Core

Middleware
- Access Control Middleware
  - AccessControlMiddleware
    - AccessControlMiddleware.__init__()

Docker Settings

Django settings for different database configuration. The docker container started in https://github.com/digitalfabrik/integreat-compass/blob/develop/tools/run.sh exposes the alternative port 5434.

All other settings are imported from settings.

For more information on this file, see Django settings. For the full list of settings and their values, see Settings.

integreat_compass.core.docker_settings.DATABASES = {'default': {'ENGINE': 'django.db.backends.postgresql', 'HOST': 'localhost', 'NAME': 'integreat-compass', 'PASSWORD': 'password', 'PORT': '5434', 'USER': 'integreat'}}

A dictionary containing the settings for all databases to be used with this Django installation (see DATABASES)

{
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'HOST': 'localhost',
        'NAME': 'integreat-compass',
        'PASSWORD': 'password',
        'PORT': '5434',
        'USER': 'integreat',
    },
}

Settings

Django settings for integreat_compass project.

Generated by ‘django-admin startproject’ using Django 4.1.2.

For more information on this file, see https://docs.djangoproject.com/en/4.1/topics/settings/

For the full list of settings and their values, see https://docs.djangoproject.com/en/4.1/ref/settings/

integreat_compass.core.settings.AVAILABLE_LANGUAGES = {'de': 'German', 'en': 'English'}

A list of all available languages with locale files for translated strings

{'de': 'German', 'en': 'English'}

integreat_compass.core.settings.CHANGED_OFFER_GREMIUM_SIZE = 4: Maximum votes cast on changed offers

integreat_compass.core.settings.DATABASES = {'default': {'ATOMIC_REQUESTS': False, 'AUTOCOMMIT': True, 'CONN_HEALTH_CHECKS': False, 'CONN_MAX_AGE': 0, 'ENGINE': 'django.db.backends.postgresql', 'HOST': 'localhost', 'NAME': 'integreat-compass', 'OPTIONS': {}, 'PASSWORD': '', 'PORT': '5432', 'TEST': {'CHARSET': None, 'COLLATION': None, 'MIGRATE': True, 'MIRROR': None, 'NAME': None}, 'TIME_ZONE': None, 'USER': 'integreat'}}

A dictionary containing the settings for all databases to be used with this Django installation (see DATABASES)

{
    'default': {
        'ATOMIC_REQUESTS': False,
        'AUTOCOMMIT': True,
        'CONN_HEALTH_CHECKS': False,
        'CONN_MAX_AGE': 0,
        'ENGINE': 'django.db.backends.postgresql',
        'HOST': 'localhost',
        'NAME': 'integreat-compass',
        'OPTIONS': {},
        'PASSWORD': '',
        'PORT': '5432',
        'TEST': {
            'CHARSET': None,
            'COLLATION': None,
            'MIGRATE': True,
            'MIRROR': None,
            'NAME': None,
        },
        'TIME_ZONE': None,
        'USER': 'integreat',
    },
}

integreat_compass.core.settings.DEFAULT_LANGUAGES = ['de', 'en']

The default UI languages

['de', 'en']

integreat_compass.core.settings.DEFAULT_OFFER_LANGUAGE = {'english_name': 'German', 'native_name': 'Deutsch'}

The default offer language

{'english_name': 'German', 'native_name': 'Deutsch'}

integreat_compass.core.settings.LANGUAGES = [('de', 'German'), ('en', 'English')]

The list of languages which are available in the UI (see LANGUAGES and Internationalization and localization)

[('de', 'German'), ('en', 'English')]

integreat_compass.core.settings.LOCALE_PATHS = ['/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/locale']

A list of directories where Django looks for translation files (see LOCALE_PATHS and Internationalization and localization)

[
    '/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/locale',
]

integreat_compass.core.settings.MEDIA_MAX_UPLOAD_SIZE = 3145728: The maximum size of media files in bytes

integreat_compass.core.settings.MEDIA_ROOT = '/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/media': Absolute filesystem path to the directory that will hold user-uploaded files (see MEDIA_ROOT)

integreat_compass.core.settings.MEDIA_URL = '/media/': URL that handles the media served from MEDIA_ROOT (see MEDIA_URL)

integreat_compass.core.settings.NEW_OFFER_GREMIUM_SIZE = 6: Maximum votes cast on new offers

integreat_compass.core.settings.STATICFILES_DIRS = ['/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/static', '/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/static/dist']

This setting defines the additional locations the django.contrib.staticfiles app will traverse to collect static files for deployment or to serve them during development (see STATICFILES_DIRS and Managing static files).

[
    '/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/static',
    '/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/static/dist',
]

integreat_compass.core.settings.STATICFILES_FINDERS = ('django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder')

The list of finder backends that know how to find static files in various locations (see STATICFILES_FINDERS)

(
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
)

integreat_compass.core.settings.STATIC_ROOT = None: The absolute path to the output directory where django.contrib.staticfiles will put static files for deployment (see STATIC_ROOT and Managing static files) In debug mode, this is not required since django.contrib.staticfiles can directly serve these files.

integreat_compass.core.settings.STATIC_URL = 'static/': URL to use in development when referring to static files located in STATICFILES_DIRS (see STATIC_URL and Managing static files)

integreat_compass.core.settings.WEBPACK_LOADER = {'DEFAULT': {'BUNDLE_DIR_NAME': '', 'STATS_FILE': '/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/webpack-stats.json'}}

Overwrite default bundle directory

{
    'DEFAULT': {
        'BUNDLE_DIR_NAME': '',
        'STATS_FILE': '/home/docs/checkouts/readthedocs.org/user_builds/integreat-compass/envs/latest/lib/python3.9/site-packages/integreat_compass/webpack-stats.json',
    },
}

Urls

integreat_compass URL Configuration

The urlpatterns list routes URLs to views. For more information please see:: https://docs.djangoproject.com/en/4.1/topics/http/urls/

Examples:

Function views

Add an import: from my_app import views
Add a URL to urlpatterns: path(‘’, views.home, name=’home’)

Class-based views

Add an import: from other_app.views import Home
Add a URL to urlpatterns: path(‘’, Home.as_view(), name=’home’)

Including another URLconf

Import the include() function: from django.urls import include, path
Add a URL to urlpatterns: path(‘blog/’, include(‘blog.urls’))

Wsgi

WSGI config for integreat_compass project.

It exposes the WSGI callable as a module-level variable named application.

For more information on this file, see https://docs.djangoproject.com/en/4.1/howto/deployment/wsgi/