mirror of
https://github.com/BlackWallTeam/Backend.git
synced 2024-11-23 17:23:42 +03:00
334 lines
14 KiB
Python
334 lines
14 KiB
Python
"""
|
|
Base settings to build other settings files upon.
|
|
"""
|
|
from pathlib import Path
|
|
|
|
import environ
|
|
import structlog
|
|
|
|
ROOT_DIR = Path(__file__).resolve(strict=True).parent.parent.parent
|
|
# real_estate_search/
|
|
APPS_DIR = ROOT_DIR / "real_estate_search"
|
|
env = environ.Env()
|
|
|
|
READ_DOT_ENV_FILE = env.bool("DJANGO_READ_DOT_ENV_FILE", default=True)
|
|
if READ_DOT_ENV_FILE:
|
|
# OS environment variables take precedence over variables from .env
|
|
env.read_env(str(ROOT_DIR / ".env"))
|
|
|
|
# GENERAL
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#debug
|
|
DEBUG = env.bool("DJANGO_DEBUG", False)
|
|
# Local time zone. Choices are
|
|
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
|
|
# though not all of them may be available with every OS.
|
|
# In Windows, this must be set to your system time zone.
|
|
TIME_ZONE = "Europe/Moscow"
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#language-code
|
|
LANGUAGE_CODE = "en-us"
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#site-id
|
|
SITE_ID = 1
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#use-i18n
|
|
USE_I18N = True
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#use-tz
|
|
USE_TZ = True
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#locale-paths
|
|
LOCALE_PATHS = [str(ROOT_DIR / "locale")]
|
|
|
|
# DATABASES
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#databases
|
|
DATABASES = {"default": env.db("DATABASE_URL")}
|
|
DATABASES["default"]["ATOMIC_REQUESTS"] = True
|
|
# https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-DEFAULT_AUTO_FIELD
|
|
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
|
|
|
|
# URLS
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#root-urlconf
|
|
ROOT_URLCONF = "config.urls"
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#wsgi-application
|
|
WSGI_APPLICATION = "config.wsgi.application"
|
|
|
|
# APPS
|
|
# ------------------------------------------------------------------------------
|
|
DJANGO_APPS = [
|
|
"django.contrib.auth",
|
|
"django.contrib.contenttypes",
|
|
"django.contrib.sessions",
|
|
"django.contrib.sites",
|
|
"django.contrib.messages",
|
|
"django.contrib.staticfiles",
|
|
# "django.contrib.humanize", # Handy template tags
|
|
"django.contrib.admin",
|
|
"django.forms",
|
|
]
|
|
THIRD_PARTY_APPS = [
|
|
"django_celery_beat",
|
|
"rest_framework",
|
|
"rest_framework.authtoken",
|
|
"corsheaders",
|
|
"drf_spectacular",
|
|
"django_filters",
|
|
]
|
|
|
|
LOCAL_APPS = ["real_estate_search.users", "real_estate_search.search"]
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
|
|
INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
|
|
|
|
# MIGRATIONS
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#migration-modules
|
|
MIGRATION_MODULES = {"sites": "real_estate_search.contrib.sites.migrations"}
|
|
|
|
# AUTHENTICATION
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#authentication-backends
|
|
AUTHENTICATION_BACKENDS = ["django.contrib.auth.backends.ModelBackend"]
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#auth-user-model
|
|
AUTH_USER_MODEL = "users.User"
|
|
|
|
# PASSWORDS
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#password-hashers
|
|
PASSWORD_HASHERS = [
|
|
# https://docs.djangoproject.com/en/dev/topics/auth/passwords/#using-argon2-with-django
|
|
"django.contrib.auth.hashers.Argon2PasswordHasher",
|
|
"django.contrib.auth.hashers.PBKDF2PasswordHasher",
|
|
"django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
|
|
"django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
|
|
]
|
|
# 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"},
|
|
]
|
|
|
|
# MIDDLEWARE
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#middleware
|
|
MIDDLEWARE = [
|
|
"django.middleware.security.SecurityMiddleware",
|
|
"corsheaders.middleware.CorsMiddleware",
|
|
"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.common.BrokenLinkEmailsMiddleware",
|
|
"django.middleware.clickjacking.XFrameOptionsMiddleware",
|
|
]
|
|
|
|
# STATIC
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#static-root
|
|
STATIC_ROOT = str(ROOT_DIR / "staticfiles")
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#static-url
|
|
STATIC_URL = "/static/"
|
|
# https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#std:setting-STATICFILES_DIRS
|
|
STATICFILES_DIRS = [str(APPS_DIR / "static")]
|
|
# https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#staticfiles-finders
|
|
STATICFILES_FINDERS = [
|
|
"django.contrib.staticfiles.finders.FileSystemFinder",
|
|
"django.contrib.staticfiles.finders.AppDirectoriesFinder",
|
|
]
|
|
|
|
# MEDIA
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#media-root
|
|
MEDIA_ROOT = str(APPS_DIR / "media")
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#media-url
|
|
MEDIA_URL = "/media/"
|
|
|
|
# TEMPLATES
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#templates
|
|
TEMPLATES = [
|
|
{
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-TEMPLATES-BACKEND
|
|
"BACKEND": "django.template.backends.django.DjangoTemplates",
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#dirs
|
|
"DIRS": [str(APPS_DIR / "templates")],
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#app-dirs
|
|
"APP_DIRS": True,
|
|
"OPTIONS": {
|
|
# 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",
|
|
],
|
|
},
|
|
}
|
|
]
|
|
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#form-renderer
|
|
FORM_RENDERER = "django.forms.renderers.TemplatesSetting"
|
|
|
|
# FIXTURES
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#fixture-dirs
|
|
FIXTURE_DIRS = (str(APPS_DIR / "fixtures"),)
|
|
|
|
# SECURITY
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#session-cookie-httponly
|
|
SESSION_COOKIE_HTTPONLY = True
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#csrf-cookie-httponly
|
|
CSRF_COOKIE_HTTPONLY = True
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#secure-browser-xss-filter
|
|
SECURE_BROWSER_XSS_FILTER = True
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#x-frame-options
|
|
X_FRAME_OPTIONS = "DENY"
|
|
|
|
# ADMIN
|
|
# ------------------------------------------------------------------------------
|
|
# Django Admin URL.
|
|
ADMIN_URL = "admin/"
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#admins
|
|
ADMINS = [("""sanspie""", "sanspie@akarpov.ru")]
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#managers
|
|
MANAGERS = ADMINS
|
|
|
|
# LOGGING
|
|
# ------------------------------------------------------------------------------
|
|
# https://docs.djangoproject.com/en/dev/ref/settings/#logging
|
|
# See https://docs.djangoproject.com/en/dev/topics/logging for
|
|
# more details on how to customize your logging configuration.
|
|
LOGGING = {
|
|
"version": 1,
|
|
"disable_existing_loggers": False,
|
|
"formatters": {
|
|
"json_formatter": {
|
|
"()": structlog.stdlib.ProcessorFormatter,
|
|
"processor": structlog.processors.JSONRenderer(),
|
|
},
|
|
"plain_console": {
|
|
"()": structlog.stdlib.ProcessorFormatter,
|
|
"processor": structlog.dev.ConsoleRenderer(),
|
|
},
|
|
"key_value": {
|
|
"()": structlog.stdlib.ProcessorFormatter,
|
|
"processor": structlog.processors.KeyValueRenderer(
|
|
key_order=["timestamp", "level", "event", "logger"]
|
|
),
|
|
},
|
|
},
|
|
"handlers": {
|
|
"console": {
|
|
"class": "logging.StreamHandler",
|
|
"formatter": "plain_console",
|
|
},
|
|
"json_file": {
|
|
"class": "logging.handlers.WatchedFileHandler",
|
|
"filename": "logs/json.log",
|
|
"formatter": "json_formatter",
|
|
},
|
|
"flat_line_file": {
|
|
"class": "logging.handlers.WatchedFileHandler",
|
|
"filename": "logs/flat_line.log",
|
|
"formatter": "key_value",
|
|
},
|
|
},
|
|
"loggers": {
|
|
"django_structlog": {
|
|
"handlers": ["console", "flat_line_file", "json_file"],
|
|
"level": "INFO",
|
|
},
|
|
# Make sure to replace the following logger's name for yours
|
|
"django_structlog_demo_project": {
|
|
"handlers": ["console", "flat_line_file", "json_file"],
|
|
"level": "INFO",
|
|
},
|
|
},
|
|
}
|
|
|
|
structlog.configure(
|
|
processors=[
|
|
structlog.contextvars.merge_contextvars,
|
|
structlog.stdlib.filter_by_level,
|
|
structlog.processors.TimeStamper(fmt="iso"),
|
|
structlog.stdlib.add_logger_name,
|
|
structlog.stdlib.add_log_level,
|
|
structlog.stdlib.PositionalArgumentsFormatter(),
|
|
structlog.processors.StackInfoRenderer(),
|
|
structlog.processors.format_exc_info,
|
|
structlog.processors.UnicodeDecoder(),
|
|
structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
|
|
],
|
|
logger_factory=structlog.stdlib.LoggerFactory(),
|
|
cache_logger_on_first_use=True,
|
|
)
|
|
|
|
# Celery
|
|
# ------------------------------------------------------------------------------
|
|
if USE_TZ:
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-timezone
|
|
CELERY_TIMEZONE = TIME_ZONE
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-broker_url
|
|
CELERY_BROKER_URL = env("CELERY_BROKER_URL")
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-result_backend
|
|
CELERY_RESULT_BACKEND = CELERY_BROKER_URL
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#result-extended
|
|
CELERY_RESULT_EXTENDED = True
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#result-backend-always-retry
|
|
# https://github.com/celery/celery/pull/6122
|
|
CELERY_RESULT_BACKEND_ALWAYS_RETRY = True
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#result-backend-max-retries
|
|
CELERY_RESULT_BACKEND_MAX_RETRIES = 10
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-accept_content
|
|
CELERY_ACCEPT_CONTENT = ["json"]
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-task_serializer
|
|
CELERY_TASK_SERIALIZER = "json"
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-result_serializer
|
|
CELERY_RESULT_SERIALIZER = "json"
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-time-limit
|
|
CELERY_TASK_TIME_LIMIT = 5 * 60
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-soft-time-limit
|
|
CELERY_TASK_SOFT_TIME_LIMIT = 60
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#beat-scheduler
|
|
CELERY_BEAT_SCHEDULER = "django_celery_beat.schedulers:DatabaseScheduler"
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#worker-send-task-events
|
|
CELERY_WORKER_SEND_TASK_EVENTS = True
|
|
# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std-setting-task_send_sent_event
|
|
CELERY_TASK_SEND_SENT_EVENT = True
|
|
# DRF
|
|
# -------------------------------------------------------------------------------
|
|
# django-rest-framework - https://www.django-rest-framework.org/api-guide/settings/
|
|
REST_FRAMEWORK = {
|
|
"DEFAULT_AUTHENTICATION_CLASSES": (
|
|
"rest_framework.authentication.SessionAuthentication",
|
|
"rest_framework.authentication.TokenAuthentication",
|
|
),
|
|
"DEFAULT_PERMISSION_CLASSES": ("rest_framework.permissions.IsAuthenticated",),
|
|
"DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
|
|
}
|
|
|
|
# django-cors-headers - https://github.com/adamchainz/django-cors-headers#setup
|
|
CORS_URLS_REGEX = r"^/api/.*$"
|
|
|
|
# By Default swagger ui is available only to admin user(s). You can change permission classes to change that
|
|
# See more configuration options at https://drf-spectacular.readthedocs.io/en/latest/settings.html#settings
|
|
SPECTACULAR_SETTINGS = {
|
|
"TITLE": "real estate search API",
|
|
"DESCRIPTION": "Documentation of API endpoints of real estate search",
|
|
"VERSION": "1.0.0",
|
|
"SERVE_PERMISSIONS": [],
|
|
"SERVERS": [
|
|
{"url": "http://127.0.0.1:3000", "description": "Local Development server"},
|
|
{"url": "https://dev.akarpov.ru", "description": "Production server"},
|
|
],
|
|
}
|