Initial commit

.gitignore

@@ -0,0 +1,156 @@
+.idea
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

README.md

@@ -0,0 +1,3 @@
+# Notfellchen
+
+App to organize and search foster animals

notfellchen.cfg

@@ -0,0 +1,16 @@
+# DEBUG CONFIGURATION
+# DO NOT USE IN PRODUCTION
+
+[ilmo]
+instance_name=Notfellchen DEBUG
+host=localhost
+
+[django]
+secret=CHANGE-ME
+debug=True
+
+[database]
+backend=sqlite
+name=notfellchen
+
+

pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+
+
+[project]
+name = "notfellchen"
+description = "A tool to help."
+authors = [
+  {name = "moanos", email = "julian-samuel@gebuehr.net"},
+]
+maintainers = [
+  {name = "moanos", email = "julian-samuel@gebuehr.net"},
+]
+keywords = ["matrix", "registration", "bot", "user", "registration", "API"  ]
+license = {text = "AGPL-3.0-or-later"}
+classifiers = [
+    "Environment :: Web",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.11",
+    "Framework :: Django",
+]
+dependencies = [
+    "Django",
+    "coverage",
+    "codecov",
+    "sphinx",
+    "sphinx-rtd-theme",
+    "gunicorn",
+    "fontawesomefree",
+    "whitenoise"
+]
+dynamic = ["version", "readme"]
+
+[project.urls]
+homepage = "https://hyteck.de"
+repository = "https://github.com/moan0s/notfellchen/"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.scripts]
+nf-manage = 'notfellchen.main:main'
+
+
+[tool.setuptools.dynamic]
+version = {attr = "notfellchen.__version__"}
+readme = {file = "README.md"}
+

src/fellchensammlung/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

src/fellchensammlung/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class FellchensammlungConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'fellchensammlung'

src/fellchensammlung/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

src/fellchensammlung/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

src/fellchensammlung/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+
+from . import views
+
+urlpatterns = [
+    path("", views.index, name="index"),
+]

src/fellchensammlung/views.py

@@ -0,0 +1,7 @@
+from django.shortcuts import render
+
+from django.http import HttpResponse
+
+
+def index(request):
+    return HttpResponse("Hello, world. Look at all the little guys&girls and non-binary pals!")

src/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notfellchen.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

src/notfellchen/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

src/notfellchen/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for notfellchen 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/5.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notfellchen.settings')
+
+application = get_asgi_application()

src/notfellchen/main.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "notfellchen.settings")
+
+    try:
+        import django
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

src/notfellchen/settings.py

@@ -0,0 +1,231 @@
+"""
+Django settings for notfellchen project.
+
+Generated by 'django-admin startproject' using Django 3.2.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+
+from pathlib import Path
+import os
+import configparser
+from django.utils.translation import gettext_lazy as _
+
+"""CONFIG PARSER """
+config = configparser.RawConfigParser()
+if 'NF_CONFIG_FILE' in os.environ:
+    config.read_file(open(os.environ.get('NF_CONFIG_FILE'), encoding='utf-8'))
+if 'DOCKER_BUILD' in os.environ and os.environ.get('DOCKER_BUILD'):
+    config.read("docker/build.cfg", encoding='utf-8')
+else:
+    config.read(['/etc/notfellchen/notfellchen.cfg', os.path.expanduser('~/.notfellchen.cfg'), 'notfellchen.cfg'],
+                encoding='utf-8')
+CONFIG_FILE = config
+
+"""LOGGING"""
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+        },
+    },
+    "root": {
+        "handlers": ["console"],
+        "level": "WARNING",
+    },
+    "loggers": {
+        "django": {
+            "handlers": ["console"],
+            "level": os.getenv("DJANGO_LOG_LEVEL", "DEBUG"),
+            "propagate": False,
+        },
+    },
+}
+
+""" DJANGO """
+SECRET_KEY = config.get('django', 'secret')
+DEBUG = config.getboolean('django', 'debug', fallback=False)
+
+""" DATABASE """
+DB_BACKEND = config.get("database", "backend", fallback="sqlite3")
+DB_NAME = config.get("database", "name", fallback="ilmo.sqlite3")
+DB_USER = config.get("database", "user", fallback='')
+DB_PASSWORD = config.get("database", "password", fallback='')
+DB_HOST = config.get("database", "host", fallback='')
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+LOCALE_PATHS = [os.path.join(BASE_DIR, 'locale')]
+
+""" E-MAIL  """
+console_only = config.getboolean("mail", "console_only", fallback="true")
+EMAIL_SUBJECT_PREFIX = config.get("mail", "prefix", fallback="[notfellchen]]")
+if console_only:
+    EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
+else:
+    EMAIL_HOST = config.get('mail', 'host', fallback='localhost')
+    EMAIL_PORT = config.getint('mail', 'port', fallback=25)
+    EMAIL_HOST_USER = config.get('mail', 'user', fallback='')
+    DEFAULT_FROM_EMAIL = config.get('mail', 'from', fallback='notfellchen@localhost')
+    EMAIL_HOST_PASSWORD = config.get('mail', 'password', fallback='')
+    EMAIL_USE_TLS = config.getboolean('mail', 'tls', fallback=False)
+    EMAIL_USE_SSL = config.getboolean('mail', 'ssl', fallback=False)
+
+
+""" SECURITY.TXT """
+SEC_CONTACT = config.get("security", "Contact", fallback="julian-samuel@gebuehr.net")
+SEC_EXPIRES = config.get("security", "Expires", fallback="2028-03-17T07:00:00.000Z")
+SEC_ENCRYPTION = config.get("security", "Encryption", fallback="https://hyteck.de/julian-samuel@gebuehr.net.pub.asc")
+SEC_LANG = config.get("security", "Preferred-Languages", fallback="en, de")
+SEC_SCOPE = config.get("security", "Scope",
+                       fallback="The provided contact is the main developer of the application and NOT necessarily the "
+                                "instance")
+SEC_POLICY = config.get("security", "Policy",
+                        fallback="Do NOT include user data or detailed reports (especially public or unencrypted) "
+                                 "without being asked to do so.")
+
+""" LOCATIONS """
+STATIC_ROOT = config.get("locations", "static", fallback="/notfellchen/static")
+
+# see https://docs.djangoproject.com/en/3.2/ref/settings/#std-setting-ALLOWED_HOSTS
+ALLOWED_HOSTS = [config.get("notfellchen", "host", fallback='*')]
+CSRF_TRUSTED_ORIGINS = [f"https://{config.get('notfellchen', 'host', fallback='')}"]
+print(f"Allowed hosts: {ALLOWED_HOSTS}")
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.2/howto/static-files/
+# This is adjusted based on this guide https://testdriven.io/blog/django-docker-traefik/
+# compression and caching support (see https://whitenoise.readthedocs.io/en/latest/#quickstart-for-django-apps)
+STORAGES = {
+    "staticfiles": {
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+    },
+}
+
+STATIC_URL = '/static/'
+
+"""Application definition"""
+
+INSTALLED_APPS = [
+    'fellchensammlung',
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'fontawesomefree',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    # Static file serving & caching
+    'whitenoise.middleware.WhiteNoiseMiddleware',
+    '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',
+    'django.middleware.locale.LocaleMiddleware',
+]
+
+ROOT_URLCONF = 'notfellchen.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [os.path.join(BASE_DIR, 'templates')],
+        '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 = 'notfellchen.wsgi.application'
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+if (DB_BACKEND == "sqlite3"):
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django.db.backends.sqlite3',
+            'NAME': DB_NAME,
+        }
+    }
+elif (DB_BACKEND == "postgresql"):
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django.db.backends.postgresql',
+            'NAME': DB_NAME,
+            'USER': DB_USER,
+            'PASSWORD': DB_PASSWORD,
+            'HOST': DB_HOST,
+        }
+    }
+else:
+    print("Database backend unknown. Choose sqlite3 or postgresql")
+
+# Password validation
+# https://docs.djangoproject.com/en/3.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/3.2/topics/i18n/
+
+LANGUAGE_CODE = config.get('locale', 'default', fallback='en')
+TIME_ZONE = config.get('locale', 'timezone', fallback='UTC')
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+LANGUAGES = (
+    ('en-us', _('English')),
+    ('de', _('German')),
+)
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+
+# Redirect to home URL after login (Default redirects to /accounts/profile/)
+LOGIN_REDIRECT_URL = '/'
+
+
+REST_FRAMEWORK = {
+    'DEFAULT_AUTHENTICATION_CLASSES': [
+        'rest_framework.authentication.TokenAuthentication',
+        'rest_framework.authentication.SessionAuthentication',
+    ]
+}
+

src/notfellchen/urls.py

@@ -0,0 +1,23 @@
+"""
+URL configuration for notfellchen project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.0/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 include, path
+
+urlpatterns = [
+    path("fellchensammlung/", include("fellchensammlung.urls")),
+    path('admin/', admin.site.urls),
+]

src/notfellchen/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for notfellchen 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/5.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notfellchen.settings')
+
+application = get_wsgi_application()