apis-acdhch-default-settings 0.1.24__py3-none-any.whl → 1.1.0__py3-none-any.whl

apis_acdhch_default_settings/settings.py

@@ -30,41 +30,11 @@ BASE_DIR = os.path.dirname(
     os.path.dirname(os.path.abspath(os.path.join(__file__, "../")))
 )
 
-SHARED_URL = "https://shared.acdh.oeaw.ac.at/"
-
-PROJECT_NAME = "apis"
-PROJECT_SHARED = "https://shared.acdh.oeaw.ac.at/apis/"
-PROJECT_DEFAULT_MD = {
-    "title": "TITLE",
-    "author": "Matthias Schlögl, Peter Andorfer",
-    "subtitle": "SUBTITLE",
-    "description": """This is a default metadata file. To change this, provide\
-    provide a following file {PROJECT_SHARED}/{PROJECT_NAME}/metadata.json""",
-    "github": "https://github.com/acdh-oeaw/apis-webpage-base",
-    "production instance": None,
-    "purpose_de": "",
-    "purpose_en": """""",
-    "version": ["apis_core", "charts", "django"],
-    "matomo_id": "",
-    "matomo_url": "",
-    "imprint": "/imprint",
-    "social_media": [
-        ("fab fa-twitter", "https://twitter.com/ACDH_OeAW"),
-        ("fab fa-youtube", "https://www.youtube.com/channel/UCgaEMaMbPkULYRI5u6gvG-w"),
-    ],
-    "social_media": [
-        ("fab fa-twitter fa-2x", "https://twitter.com/ACDH_OeAW"),
-        (
-            "fab fa-youtube fa-2x",
-            "https://www.youtube.com/channel/UCgaEMaMbPkULYRI5u6gvG-w",
-        ),
-    ],
-    "app_type": "database",
-}
-
 # Application definition
-
+# put apis_override_select2js at the beginning of the list
+# to make its static files weigh more than from the other apps
 INSTALLED_APPS = [
+    "apis_override_select2js",
     "dal",
     "dal_select2",
     "django.contrib.admin",
@@ -73,7 +43,6 @@ INSTALLED_APPS = [
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
-    "reversion",
     "crispy_forms",
     "crispy_bootstrap4",
     "django_filters",
@@ -86,27 +55,28 @@ INSTALLED_APPS = [
     "apis_core.apis_vocabularies",
     "apis_core.generic",
     "rest_framework.authtoken",
-    # "drf_yasg",
     "drf_spectacular",
     "csvexport",
     "apis_ontology",
 ]
 
-# put apis_override_select2js at the beginning of the list
-# to make its static files weigh more than from the other apps
-INSTALLED_APPS = ["apis_override_select2js"] + INSTALLED_APPS
-
+# https://docs.djangoproject.com/en/5.0/ref/settings/#std-setting-USE_X_FORWARDED_HOST
 USE_X_FORWARDED_HOST = True
+# https://docs.djangoproject.com/en/5.0/ref/settings/#secure-proxy-ssl-header
 SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
 
+# drf-spectacular settings
+# https://drf-spectacular.readthedocs.io/en/latest/settings.html
 SPECTACULAR_SETTINGS: Dict[str, Any] = {
     "TITLE": "APIS generic API",
     "DESCRIPTIOPN": "Provides access to the main APIS data-model endpoints.",
     "LICENSE": {"name": "MIT License", "url": "https://www.mit.edu/~amini/LICENSE.md"},
     "VERSION": "0.13",
+    "DEFAULT_GENERATOR_CLASS": 'apis_core.generic.generators.CustomSchemaGenerator'
 }
 
-
+# django-csp settings
+# https://django-csp.readthedocs.io/en/latest/migration-guide.html#migration-guide-chapter
 CSP_DEFAULT_SRC = (
     "'self'",
     "'unsafe-inline'",
@@ -127,8 +97,12 @@ CSP_DEFAULT_SRC = (
 )
 CSP_FRAME_SRC = ("sennierer.github.io",)
 
+# django-crispy-forms settings
+# https://django-crispy-forms.readthedocs.io/en/latest/install.html#template-packs
 CRISPY_TEMPLATE_PACK = "bootstrap4"
 
+# django-rest-framework settings
+# https://www.django-rest-framework.org/api-guide/settings/
 REST_FRAMEWORK = {
     "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
     "PAGE_SIZE": 50,
@@ -147,10 +121,7 @@ REST_FRAMEWORK = {
     "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
 
-AUTHENTICATION_BACKENDS = (
-    "django.contrib.auth.backends.ModelBackend",  # this is default
-)
-
+# https://docs.djangoproject.com/en/5.0/ref/settings/#std-setting-MIDDLEWARE
 MIDDLEWARE = [
     "allow_cidr.middleware.AllowCIDRMiddleware",
     "django.middleware.security.SecurityMiddleware",
@@ -160,13 +131,15 @@ MIDDLEWARE = [
     "django.middleware.csrf.CsrfViewMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "csp.middleware.CSPMiddleware",
-    "reversion.middleware.RevisionMiddleware",
     "crum.CurrentRequestUserMiddleware",
 ]
 
+# https://docs.djangoproject.com/en/5.0/ref/settings/#root-urlconf
 ROOT_URLCONF = "apis_acdhch_default_settings.urls"
 
+# https://docs.djangoproject.com/en/5.0/ref/settings/#templates
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
@@ -183,128 +156,51 @@ TEMPLATES = [
     }
 ]
 
-# Password validation
-# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators
-
+# https://docs.djangoproject.com/en/5.0/ref/settings/#auth-password-validators
 AUTH_PASSWORD_VALIDATORS = [
-    {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
-    },
+    {"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"},
 ]
 
-APIS_BASE_URI = "TO CHANGE"
-
-APIS_MIN_CHAR = 0
 
 # Internationalization
 # https://docs.djangoproject.com/en/1.11/topics/i18n/
-
 LANGUAGE_CODE = "en"
-
 TIME_ZONE = "UTC"
-
 USE_I18N = True
-
 USE_L10N = True
-
 USE_TZ = True
 
-
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/1.11/howto/static-files/
-
 STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles/")
 STATIC_URL = "/static/"
 MEDIA_ROOT = os.path.join(BASE_DIR, "media/")
 MEDIA_URL = "/media/"
 
+# django-tables2 setting
+# https://django-tables2.readthedocs.io/en/latest/pages/custom-rendering.html#available-templates
 DJANGO_TABLES2_TEMPLATE = "django_tables2/bootstrap4.html"
 
-APIS_COMPONENTS = []
-# APIS settings
-
-APIS_TEI_TEXTS = ["xml/tei transcription"]
-APIS_CETEICEAN_CSS = "https://teic.github.io/CETEIcean/css/CETEIcean.css"
-APIS_CETEICEAN_JS = "https://teic.github.io/CETEIcean/js/CETEI.js"
-
+# apis-core-rdf settings
+APIS_BASE_URI = "TO CHANGE"
+APIS_MIN_CHAR = 0
 APIS_NEXT_PREV = True
-
-APIS_ALTERNATE_NAMES = [
-    "Taufname",
-    "Ehename",
-    "Name laut ÖBL XML",
-    "alternative Namensform",
-    "alternative name",
-    "Künstlername",
-    "Mädchenname",
-    "Pseudonym",
-    "weitere Namensform",
-]
-
-APIS_RELATIONS_FILTER_EXCLUDE = [
-    "*uri*",
-    "*tempentityclass*",
-    "user",
-    "*__id",
-    "*source*",
-    "label",
-    "*temp_entity*",
-    "*collection*",
-    "*published*",
-    "*_set",
-    "*_set__*",
-    "_ptr",
-    "baseclass",
-    "*id",
-    "*written*",
-    "relation_type__*",
-    "*__text*",
-    "text*",
-    "*annotation_set_relation*",
-    "*start_start_date*",
-    "*end_end_date*",
-    "*start_end_date*",
-    "*end_start_date*",
-    "*label*",
-    "*review*",
-    "*__name",
-    "*__status",
-    "*__references",
-    "*__notes",
-]
-
-
-
-APIS_VOCABULARIES = {"exclude": ["userAdded"]}
-
-APIS_METAINFO = {"exclude": ["groups_allowed"]}
-
-# TODO RDF: Remove this dictionary from settings entirely and attach it only to entity models
-APIS_ENTITIES = {}
-
-APIS_API_EXCLUDE_SETS = True  # exclude reverse links to entities
-
 APIS_LIST_VIEWS_ALLOWED = False
 APIS_DETAIL_VIEWS_ALLOWED = False
-MAX_AGE = 60 * 60
-
-APIS_IIIF_WORK_KIND = "IIIF"
-APIS_IIIF_ENT_IIIF_REL = "has iiif image"
-APIS_IIIF_SERVER = "https://iiif.acdh.oeaw.ac.at/"
-APIS_OSD_JS = (
-    "https://cdnjs.cloudflare.com/ajax/libs/openseadragon/2.4.0/openseadragon.min.js"
-)
-APIS_OSD_IMG_PREFIX = (
-    "https://cdnjs.cloudflare.com/ajax/libs/openseadragon/2.4.0/images/"
-)
+SHARED_URL = "https://shared.acdh.oeaw.ac.at/"
 
+# django-allow-cidr settings
+# https://github.com/mozmeao/django-allow-cidr
 ALLOWED_CIDR_NETS = ["10.0.0.0/8", "127.0.0.0/8"]
 
-DATABASES = { 'default': dj_database_url.config(default='sqlite:///db.sqlite3', conn_max_age=600) }
+# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
+# https://github.com/jazzband/dj-database-url
+DATABASES = {'default': dj_database_url.config(default='sqlite:///db.sqlite3', conn_max_age=600)}
 
+# https://docs.djangoproject.com/en/5.0/ref/settings/#allowed-hosts
 ALLOWED_HOSTS = ["localhost", "127.0.0.1"]
 if os.environ.get("PUBLIC_URL"):
     ALLOWED_HOSTS.append(re.sub(r"https?://", "", os.environ.get("PUBLIC_URL")))
@@ -312,11 +208,35 @@ if os.environ.get("PUBLIC_URL"):
 if os.environ.get("ALLOWED_HOSTS"):
     ALLOWED_HOSTS = os.environ.get("ALLOWED_HOSTS").split(",")
 
+# setting of apis_acdhch_default_settings.ldapauth
 if os.environ.get("AUTH_LDAP_USER_LIST", False):
     AUTH_LDAP_SERVER_URI = os.environ.get("ARZ_AUTH_LDAP_SERVER_URI")
     AUTH_LDAP_USER_DN_TEMPLATE = "%(user)s@oeaw.ads"
 
+    # https://docs.djangoproject.com/en/5.0/ref/settings/#std-setting-AUTHENTICATION_BACKENDS
     AUTHENTICATION_BACKENDS = [
         "apis_acdhch_default_settings.ldapauth.CustomLDAPBackend",
         "django.contrib.auth.backends.ModelBackend",
     ]
+
+# https://docs.djangoproject.com/en/5.0/howto/logging/
+# setup logging to log everything to stdout
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    'formatters': {
+       'verbose': {
+           'format': '%(asctime)s %(name)-6s %(levelname)-8s %(message)s',
+       },
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "verbose",
+        },
+    },
+    "root": {
+        "handlers": ["console"],
+        "level": "DEBUG",
+    },
+}

{apis_acdhch_default_settings-0.1.24.dist-info → apis_acdhch_default_settings-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apis-acdhch-default-settings
-Version: 0.1.24
+Version: 1.1.0
 Summary: Default settings for APIS instances at the ACDH-CH
 License: MIT
 Author: Birger Schacht

apis_acdhch_default_settings-1.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+apis_acdhch_default_settings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apis_acdhch_default_settings/ldapauth.py,sha256=P1NDgWG2Pp4JzqoETq3VDC3DtECoEIXWBA3Lzn6CUIA,423
+apis_acdhch_default_settings/settings.py,sha256=iW-8jaS8tvlbOJXgkwjGwKHU9rGi2Gb4vqVCqCa_TSU,8156
+apis_acdhch_default_settings/urls.py,sha256=VDvjdb940573U-xuwGYwYZTJJRgTeSgnlNCm7Hj8kGs,946
+apis_acdhch_default_settings-1.1.0.dist-info/METADATA,sha256=54SYuZtpTIaA4NVq914P1e9tRGt9mDRC9vwlij-5rDg,903
+apis_acdhch_default_settings-1.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+apis_acdhch_default_settings-1.1.0.dist-info/RECORD,,

{apis_acdhch_default_settings-0.1.24.dist-info → apis_acdhch_default_settings-1.1.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.8.1
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any

apis_acdhch_default_settings-0.1.24.dist-info/RECORD

@@ -1,7 +0,0 @@
-apis_acdhch_default_settings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apis_acdhch_default_settings/ldapauth.py,sha256=P1NDgWG2Pp4JzqoETq3VDC3DtECoEIXWBA3Lzn6CUIA,423
-apis_acdhch_default_settings/settings.py,sha256=OaAxi-UHH_pyNS3fEYXEcMJ3k70_5i0MmDqZQktLscY,9108
-apis_acdhch_default_settings/urls.py,sha256=VDvjdb940573U-xuwGYwYZTJJRgTeSgnlNCm7Hj8kGs,946
-apis_acdhch_default_settings-0.1.24.dist-info/METADATA,sha256=IIvdpPYUk8Az__OQy84w8SbIh1EQ6oJx_rvnt9pfyDE,904
-apis_acdhch_default_settings-0.1.24.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-apis_acdhch_default_settings-0.1.24.dist-info/RECORD,,