apis-acdhch-default-settings 1.0.0__tar.gz → 1.1.1__tar.gz

{apis_acdhch_default_settings-1.0.0 → apis_acdhch_default_settings-1.1.1}/PKG-INFO

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

{apis_acdhch_default_settings-1.0.0 → apis_acdhch_default_settings-1.1.1}/apis_acdhch_default_settings/settings.py

@@ -30,38 +30,6 @@ 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
@@ -80,30 +48,35 @@ INSTALLED_APPS = [
     "django_filters",
     "django_tables2",
     "rest_framework",
-    "apis_core.core",
+    "apis_ontology",
     "apis_core.apis_entities",
     "apis_core.apis_metainfo",
     "apis_core.apis_relations",
     "apis_core.apis_vocabularies",
     "apis_core.generic",
+    "apis_core.core",
     "rest_framework.authtoken",
-    # "drf_yasg",
     "drf_spectacular",
     "csvexport",
-    "apis_ontology",
 ]
 
+# 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'",
@@ -124,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,
@@ -144,6 +121,7 @@ REST_FRAMEWORK = {
     "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
 
+# https://docs.djangoproject.com/en/5.0/ref/settings/#std-setting-MIDDLEWARE
 MIDDLEWARE = [
     "allow_cidr.middleware.AllowCIDRMiddleware",
     "django.middleware.security.SecurityMiddleware",
@@ -153,12 +131,15 @@ MIDDLEWARE = [
     "django.middleware.csrf.CsrfViewMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "csp.middleware.CSPMiddleware",
     "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",
@@ -175,9 +156,7 @@ 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.MinimumLengthValidator"},
@@ -185,44 +164,43 @@ AUTH_PASSWORD_VALIDATORS = [
     {"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-core-rdf settings
+APIS_BASE_URI = "TO CHANGE"
+APIS_MIN_CHAR = 0
 APIS_NEXT_PREV = True
-APIS_API_EXCLUDE_SETS = True  # exclude reverse links to entities
 APIS_LIST_VIEWS_ALLOWED = False
 APIS_DETAIL_VIEWS_ALLOWED = False
-MAX_AGE = 60 * 60
+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"]
 
+# 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")))
@@ -230,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-1.0.0 → apis_acdhch_default_settings-1.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "apis-acdhch-default-settings"
-version = "1.0.0"
+version = "1.1.1"
 description = "Default settings for APIS instances at the ACDH-CH"
 authors = ["Birger Schacht <birger.schacht@oeaw.ac.at>"]
 license = "MIT"