trustpoint.settings
===================

.. py:module:: trustpoint.settings

.. autoapi-nested-parse::

   Django settings for trustpoint project.

   Generated by 'django-admin startproject' using Django 5.0.1.

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

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



Attributes
----------

.. autoapisummary::

   trustpoint.settings.APP_VERSION
   trustpoint.settings.BASE_DIR
   trustpoint.settings.LOCALE_PATHS
   trustpoint.settings.STATIC_URL
   trustpoint.settings.MEDIA_ROOT
   trustpoint.settings.MEDIA_URL
   trustpoint.settings.STATICFILES_DIRS
   trustpoint.settings.STATIC_ROOT
   trustpoint.settings.LOG_DIR_PATH
   trustpoint.settings.LOG_FILE_PATH
   trustpoint.settings.BACKUP_FILE_PATH
   trustpoint.settings.PUBLIC_PATHS
   trustpoint.settings.ALLOWED_HOSTS
   trustpoint.settings.WSGI_APPLICATION
   trustpoint.settings.ADVERTISED_HOST
   trustpoint.settings.ADVERTISED_PORT
   trustpoint.settings.DOCKER_CONTAINER
   trustpoint.settings.DEBUG
   trustpoint.settings.ADMIN_ENABLED
   trustpoint.settings.DEVELOPMENT_ENV
   trustpoint.settings.POSTGRESQL
   trustpoint.settings.DATABASE_ENGINE
   trustpoint.settings.DATABASE_HOST
   trustpoint.settings.DATABASE_PORT
   trustpoint.settings.POSTGRES_DB
   trustpoint.settings.DATABASE_USER
   trustpoint.settings.DATABASE_PASSWORD
   trustpoint.settings.DEFAULT_FROM_EMAIL
   trustpoint.settings.EMAIL_BACKEND
   trustpoint.settings._email_host
   trustpoint.settings.EMAIL_BACKEND
   trustpoint.settings.STORAGES
   trustpoint.settings.DEFAULT_AUTO_FIELD
   trustpoint.settings.CRISPY_ALLOWED_TEMPLATE_PACKS
   trustpoint.settings.CRISPY_TEMPLATE_PACK
   trustpoint.settings.LOGIN_REDIRECT_URL
   trustpoint.settings.LOGIN_URL
   trustpoint.settings.DJANGO_LOG_LEVEL
   trustpoint.settings.TAGGIT_CASE_INSENSITIVE
   trustpoint.settings.DATE_FORMAT
   trustpoint.settings.ROOT_URLCONF
   trustpoint.settings.LANGUAGE_CODE
   trustpoint.settings.LANGUAGES
   trustpoint.settings.USE_I18N
   trustpoint.settings.USE_TZ
   trustpoint.settings.TIME_ZONE
   trustpoint.settings.INSTALLED_APPS
   trustpoint.settings.TEST_RUNNER
   trustpoint.settings.MIDDLEWARE
   trustpoint.settings.TEMPLATES
   trustpoint.settings.AUTH_PASSWORD_VALIDATORS
   trustpoint.settings.DATABASES
   trustpoint.settings.SECRET_KEY
   trustpoint.settings.LOGGING


Classes
-------

.. autoapisummary::

   trustpoint.settings.UTCFormatter
   trustpoint.settings.UIConfig


Functions
---------

.. autoapisummary::

   trustpoint.settings.app_version
   trustpoint.settings.is_postgre_available


Module Contents
---------------

.. py:data:: APP_VERSION

.. py:function:: app_version(request)

.. py:data:: BASE_DIR

.. py:data:: LOCALE_PATHS

.. py:data:: STATIC_URL
   :value: 'static/'


.. py:data:: MEDIA_ROOT

.. py:data:: MEDIA_URL
   :value: '/media/'


.. py:data:: STATICFILES_DIRS

.. py:data:: STATIC_ROOT

.. py:data:: LOG_DIR_PATH

.. py:data:: LOG_FILE_PATH

.. py:data:: BACKUP_FILE_PATH

.. py:data:: PUBLIC_PATHS
   :value: ['/setup-wizard', '/.well-known/cmp', '/.well-known/est', '/aoki', '/crl']


.. py:function:: is_postgre_available()

   Checks whether PostgreSQL is available and issues differentiated error messages.

   :returns: True, if PostgreSQL is available and accessible.
   :rtype: bool

   :raises RuntimeError: If PostgreSQL is deactivated, not reachable or not accessible.


.. py:data:: ALLOWED_HOSTS
   :value: ['*']


.. py:data:: WSGI_APPLICATION
   :value: 'trustpoint.wsgi.application'


.. py:data:: ADVERTISED_HOST
   :value: '127.0.0.1'


.. py:data:: ADVERTISED_PORT
   :value: 443


.. py:data:: DOCKER_CONTAINER
   :value: False


.. py:data:: DEBUG
   :value: True


.. py:data:: ADMIN_ENABLED
   :value: True


.. py:data:: DEVELOPMENT_ENV
   :value: True


.. py:data:: POSTGRESQL
   :value: True


.. py:data:: DATABASE_ENGINE
   :value: 'django.db.backends.postgresql'


.. py:data:: DATABASE_HOST
   :value: 'localhost'


.. py:data:: DATABASE_PORT
   :value: '5432'


.. py:data:: POSTGRES_DB
   :value: 'trustpoint_db'


.. py:data:: DATABASE_USER
   :value: 'admin'


.. py:data:: DATABASE_PASSWORD
   :value: 'testing321'


.. py:data:: DEFAULT_FROM_EMAIL

.. py:data:: EMAIL_BACKEND
   :value: 'django.core.mail.backends.console.EmailBackend'


.. py:data:: _email_host

.. py:data:: EMAIL_BACKEND
   :value: 'django.core.mail.backends.smtp.EmailBackend'


.. py:data:: STORAGES

.. py:data:: DEFAULT_AUTO_FIELD
   :value: 'django.db.models.BigAutoField'


.. py:data:: CRISPY_ALLOWED_TEMPLATE_PACKS
   :value: 'bootstrap5'


.. py:data:: CRISPY_TEMPLATE_PACK
   :value: 'bootstrap5'


.. py:data:: LOGIN_REDIRECT_URL
   :value: 'home:dashboard'


.. py:data:: LOGIN_URL
   :value: 'users:login'


.. py:data:: DJANGO_LOG_LEVEL
   :value: 'INFO'


.. py:data:: TAGGIT_CASE_INSENSITIVE
   :value: True


.. py:data:: DATE_FORMAT
   :value: '%Y-%m-%d %H:%M:%S'


.. py:data:: ROOT_URLCONF
   :value: 'trustpoint.urls'


.. py:data:: LANGUAGE_CODE
   :value: 'en-us'


.. py:data:: LANGUAGES

.. py:data:: USE_I18N
   :value: True


.. py:data:: USE_TZ
   :value: True


.. py:data:: TIME_ZONE
   :value: 'UTC'


.. py:data:: INSTALLED_APPS
   :value: ['help_pages.apps.HelpPagesConfig', 'shared.apps.SharedConfig',...


.. py:data:: TEST_RUNNER
   :value: 'django_behave.runner.DjangoBehaveTestSuiteRunner'


.. py:data:: MIDDLEWARE
   :value: ['django.middleware.security.SecurityMiddleware',...


.. py:data:: TEMPLATES

.. py:data:: AUTH_PASSWORD_VALIDATORS

.. py:data:: DATABASES

.. py:data:: SECRET_KEY
   :value: 'DEV-ENVIRON-SECRET-KEY-lh2rw0b0z$s9e=!4see)@_8ta_up&ad&m01$i+g5z@nz5u$0wi'


.. py:class:: UTCFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

   Bases: :py:obj:`logging.Formatter`


   Custom logging formatter to use UTC time.


   .. py:attribute:: converter


.. py:data:: LOGGING

.. py:class:: UIConfig

   User interface configuration defaults.


   .. py:attribute:: paginate_by
      :type:  ClassVar[int]
      :value: 50



   .. py:attribute:: notifications_paginate_by
      :type:  ClassVar[int]
      :value: 5