initial setings

etc/logging.yaml

@@ -231,7 +231,6 @@ loggers:
         handlers:
             - libranet_django_file
 
-
     django:
         level: !env LOGLEVEL_DJANGO, DEBUG
         handlers: # review
@@ -243,7 +242,6 @@ loggers:
             - django_db_backends_handler
         propagate': False
 
-
     dotenv:
         level: !env LOGLEVEL_DOTENV, NOTSET
 

makefile

@@ -22,7 +22,7 @@
 
 
 .PHONY: install  ## full initial installation
-install: create-dirs create-dirs-extra dotenv-install poetry-install symlink-venv-dirs
+install: create-dirs create-dirs-extra dotenv-install poetry-install symlink-venv-dirs create-demo-project
 
 
 .PHONY: create-dirs-extra  ## create additional directories
@@ -44,4 +44,9 @@ post-install:
 create-dirs-extra:
 	mkdir -p var/data
 	mkdir -p var/static
-	mkdir -p var/upload
+	mkdir -p var/upload
+
+
+.PHONY: create-demo-project  ## create a demo project
+create-demo-project:
+	cd var/tmp && bin/django-admin startproject demo1

pyproject.toml

@@ -218,7 +218,7 @@ hypothesis = ">=6.72"
 nox = ">=2022.11"
 nox-poetry = ">=1.0"
 pytest = ">=7.0"
-pytest-clarity = "^1.0"
+pytest-clarity = ">=1.0"
 pytest-codecov = ">=0.5"
 pytest-cov = ">=3.0"
 pytest-click = ">=1.1"

src/libranet_django/settings.py

@@ -0,0 +1,154 @@
+"""libranet_django.settings.
+
+Django settings for libranet_django project.
+
+Generated by 'django-admin startproject' using Django 4.2.5.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.2/ref/settings/
+"""
+import os 
+import pkg_resources
+import pathlib as pl
+
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+# BASE_DIR = pl.Path(__file__).resolve().parent.parent
+DB_DIR = pl.Path(os.getenv("DB_DIR"))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = os.getenv("DJANGO_SECRET_KEY")
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = os.getenv("DJANGO_DEBUG")
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "libranet_django.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "libranet_django.utils.wsgi.application"
+ASGI_APPLICATION = "libranet_django.utils.asgi.application"
+
+# Database
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": DB_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.2/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",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.2/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.2/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+
+
+# Static files like css/js/png. cfr. https://docs.djangoproject.com/en/2.2/howto/static-files/
+STATIC_VERSION = "v1"
+STATIC_ROOT = os.getenv("STATIC_DIR")  # cfg.static_dir
+STATIC_URL = "/static/"
+
+MEDIA_ROOT = os.getenv("MEDIA_DIR")  # cfg.media_dir
+MEDIA_URL = "/media/"
+
+ADMINS = [
+    ("Wouter Vanden Hove", "[email protected]"),
+]
+
+
+
+STATICFILES_DIRS = [
+    # cfg.package_static_dir,
+    pl.Path(pkg_resources.resource_filename("libranet_django", "static"))
+]
+
+STATICFILES_FINDERS = [
+    "django.contrib.staticfiles.finders.FileSystemFinder",
+    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
+    # "sass_processor.finders.CssFinder",
+]

src/libranet_django/urls.py

@@ -0,0 +1,27 @@
+"""libranet_django.urls.
+
+URL configuration for libranet_django project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path, re_path
+from django.views.generic.base import RedirectView
+
+favicon_view = RedirectView.as_view(url="/static/favicon.png", permanent=True)
+
+urlpatterns = [
+    re_path(r"^favicon\.ico$", favicon_view),
+    path("admin/", admin.site.urls),
+]

src/libranet_django/utils/asgi.py

@@ -0,0 +1,13 @@
+"""libranet_django.utils.asgi.
+
+ASGI config for libranet_django-project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/
+"""
+
+from django.core.asgi import get_asgi_application
+
+application = get_asgi_application()

src/libranet_django/utils/wsgi.py

@@ -0,0 +1,13 @@
+"""libranet_django.utils.wsgi.
+
+WSGI config for libranet_django 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.2/howto/deployment/wsgi/
+"""
+
+from django.core.wsgi import get_wsgi_application
+
+application = get_wsgi_application()