basic-python-project 0.0.0__tar.gz

basic_python_project-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 AnhaltAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

basic_python_project-0.0.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: basic-python-project
+Version: 0.0.0
+Summary: Template: Basic Python Project
+Author-email: Christian Hänig <christian.haenig@hs-anhalt.de>
+Project-URL: Gitlab, https://gitlab.hs-anhalt.de/ki/templates/basic-python-project
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: fastapi~=0.115.5
+Requires-Dist: pytest~=8.3
+Requires-Dist: pytest-asyncio~=0.24
+Requires-Dist: starlette~=0.41.3
+Requires-Dist: uvicorn~=0.32.1
+Requires-Dist: python-keycloak~=4.7.3
+Requires-Dist: python-dotenv~=1.0.1
+Requires-Dist: sqlmodel~=0.0.34
+Requires-Dist: sqlalchemy~=2.0
+Requires-Dist: asyncpg~=0.30.0
+Requires-Dist: geoalchemy2~=0.15.2
+Requires-Dist: minio~=7.2
+Requires-Dist: Pillow~=11.0
+Requires-Dist: python-multipart~=0.0.20
+Requires-Dist: sentry-sdk[fastapi]~=2.0
+Dynamic: license-file
+
+# Meinewaldki Citizen Rest Service
+
+
+## Installation for Kubernetes
+
+You need to have helm and kubectl installed.
+
+Your kubeconfig should be set to the correct cluster (meinewaldki).
+
+```bash
+kubectl config current-context
+```
+
+Navigate to the configuration directory:
+
+```bash
+cd config
+```
+
+### Keycloak
+
+For keycloak you need to run the following command:
+
+```bash
+helm install test-keycloak keycloak --namespace citizen-scientist-app
+```
+
+The configurations are in the keycloak/values.yaml file.
+
+Base configuration your endpoint will be `https://meinewaldki.anhalt.ai/dev-auth`.
+
+To uninstall keycloak run the following command:
+
+```bash
+helm uninstall test-keycloak --namespace citizen-scientist-app
+```
+
+#### Settings
+
+Log into keycloak with the following credentials:
+
+```
+Username: admin-dev
+Password: PLS_CHG_ME
+```
+
+Add a new realm for guest users.
+
+In the new realm create a new client with the ClientID `MeineWaldKIApp`.
+Enable OAuth 2.0 Device Authorization Grant.
+
+After creating the client change the following settings:
+
+Origin: `*` (should be more restrictive in production, but did not check if this works with a more restrictive setting)
+Valid Redirect URIs: `*` (should be more restrictive in production, but did not check if this works with a more restrictive setting)
+
+Add the role `guest` to the client roles.
+
+Go to Realm Settings. Set SSO Session Idle very high and SSO Session also very high (Sessions).
+
+Set Access Token Lifespan to a very high value (Tokens).
+
+Remove the first name and last name from the required user attributes (User profile).
+
+
+### Installation Rest Service
+
+I will add the automatic deployment through CI/CD later.
+
+The deployment helm is mostly written but the Docker image is not yet in a registry.
+
+
+## Run locally
+After Installing keycloak and creating your realms and changing the admin password and or admin user you can run the service locally.
+
+Add the following environment variables to your .env file:
+
+```env
+KEYCLOAK_SERVER_URL=https://meinewaldki.anhalt.ai/dev-auth/ (if not changed)
+ADMIN_USERNAME=admin_dev (if not changed)
+ADMIN_PASSWORD=PLS_CHG_ME (if not changed)
+ADMIN_REALM_NAME=master (if not changed)
+GUEST_USER_REALM_NAME=YourRealm (I set it to guest-users)
+```
+
+Mark the src directory as source root in your IDE.
+
+Run the main.py file with the working directory set to the root directory of the project.
+
+### Endpoints
+I did not setup an endpoint for cookies. This should make it easier to test the endpoints.
+
+http://127.0.0.1:5001/citizen-api/guest-user/create -> Create a new guest user
+http://127.0.0.1:5001/citizen-api/guest-user/check -> Check if Token is valid (Post request)
+http://127.0.0.1:5001/citizen-api/docs -> Swagger UI (Easy to test the endpoints)

basic_python_project-0.0.0/README.md

@@ -0,0 +1,95 @@
+# Meinewaldki Citizen Rest Service
+
+
+## Installation for Kubernetes
+
+You need to have helm and kubectl installed.
+
+Your kubeconfig should be set to the correct cluster (meinewaldki).
+
+```bash
+kubectl config current-context
+```
+
+Navigate to the configuration directory:
+
+```bash
+cd config
+```
+
+### Keycloak
+
+For keycloak you need to run the following command:
+
+```bash
+helm install test-keycloak keycloak --namespace citizen-scientist-app
+```
+
+The configurations are in the keycloak/values.yaml file.
+
+Base configuration your endpoint will be `https://meinewaldki.anhalt.ai/dev-auth`.
+
+To uninstall keycloak run the following command:
+
+```bash
+helm uninstall test-keycloak --namespace citizen-scientist-app
+```
+
+#### Settings
+
+Log into keycloak with the following credentials:
+
+```
+Username: admin-dev
+Password: PLS_CHG_ME
+```
+
+Add a new realm for guest users.
+
+In the new realm create a new client with the ClientID `MeineWaldKIApp`.
+Enable OAuth 2.0 Device Authorization Grant.
+
+After creating the client change the following settings:
+
+Origin: `*` (should be more restrictive in production, but did not check if this works with a more restrictive setting)
+Valid Redirect URIs: `*` (should be more restrictive in production, but did not check if this works with a more restrictive setting)
+
+Add the role `guest` to the client roles.
+
+Go to Realm Settings. Set SSO Session Idle very high and SSO Session also very high (Sessions).
+
+Set Access Token Lifespan to a very high value (Tokens).
+
+Remove the first name and last name from the required user attributes (User profile).
+
+
+### Installation Rest Service
+
+I will add the automatic deployment through CI/CD later.
+
+The deployment helm is mostly written but the Docker image is not yet in a registry.
+
+
+## Run locally
+After Installing keycloak and creating your realms and changing the admin password and or admin user you can run the service locally.
+
+Add the following environment variables to your .env file:
+
+```env
+KEYCLOAK_SERVER_URL=https://meinewaldki.anhalt.ai/dev-auth/ (if not changed)
+ADMIN_USERNAME=admin_dev (if not changed)
+ADMIN_PASSWORD=PLS_CHG_ME (if not changed)
+ADMIN_REALM_NAME=master (if not changed)
+GUEST_USER_REALM_NAME=YourRealm (I set it to guest-users)
+```
+
+Mark the src directory as source root in your IDE.
+
+Run the main.py file with the working directory set to the root directory of the project.
+
+### Endpoints
+I did not setup an endpoint for cookies. This should make it easier to test the endpoints.
+
+http://127.0.0.1:5001/citizen-api/guest-user/create -> Create a new guest user
+http://127.0.0.1:5001/citizen-api/guest-user/check -> Check if Token is valid (Post request)
+http://127.0.0.1:5001/citizen-api/docs -> Swagger UI (Easy to test the endpoints)

basic_python_project-0.0.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=72.2.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "basic-python-project"
+description = "Template: Basic Python Project"
+authors = [{ name = "Christian Hänig", email = "christian.haenig@hs-anhalt.de" }, ]
+
+dynamic = ["version", "readme", "dependencies"]
+
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.dynamic]
+version = { file = ["VERSION"] }
+readme = { file = ["README.md"], content-type = "text/markdown; charset=UTF-8" }
+dependencies = { file = ["requirements.txt"] }
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[project.urls]
+Gitlab = "https://gitlab.hs-anhalt.de/ki/templates/basic-python-project"

basic_python_project-0.0.0/requirements.txt

@@ -0,0 +1,15 @@
+fastapi~=0.115.5
+pytest~=8.3
+pytest-asyncio~=0.24
+starlette~=0.41.3
+uvicorn~=0.32.1
+python-keycloak~=4.7.3
+python-dotenv~=1.0.1
+sqlmodel~=0.0.34
+sqlalchemy~=2.0
+asyncpg~=0.30.0
+geoalchemy2~=0.15.2
+minio~=7.2
+Pillow~=11.0
+python-multipart~=0.0.20
+sentry-sdk[fastapi]~=2.0

basic_python_project-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

basic_python_project-0.0.0/src/basic_python_project.egg-info/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: basic-python-project
+Version: 0.0.0
+Summary: Template: Basic Python Project
+Author-email: Christian Hänig <christian.haenig@hs-anhalt.de>
+Project-URL: Gitlab, https://gitlab.hs-anhalt.de/ki/templates/basic-python-project
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: fastapi~=0.115.5
+Requires-Dist: pytest~=8.3
+Requires-Dist: pytest-asyncio~=0.24
+Requires-Dist: starlette~=0.41.3
+Requires-Dist: uvicorn~=0.32.1
+Requires-Dist: python-keycloak~=4.7.3
+Requires-Dist: python-dotenv~=1.0.1
+Requires-Dist: sqlmodel~=0.0.34
+Requires-Dist: sqlalchemy~=2.0
+Requires-Dist: asyncpg~=0.30.0
+Requires-Dist: geoalchemy2~=0.15.2
+Requires-Dist: minio~=7.2
+Requires-Dist: Pillow~=11.0
+Requires-Dist: python-multipart~=0.0.20
+Requires-Dist: sentry-sdk[fastapi]~=2.0
+Dynamic: license-file
+
+# Meinewaldki Citizen Rest Service
+
+
+## Installation for Kubernetes
+
+You need to have helm and kubectl installed.
+
+Your kubeconfig should be set to the correct cluster (meinewaldki).
+
+```bash
+kubectl config current-context
+```
+
+Navigate to the configuration directory:
+
+```bash
+cd config
+```
+
+### Keycloak
+
+For keycloak you need to run the following command:
+
+```bash
+helm install test-keycloak keycloak --namespace citizen-scientist-app
+```
+
+The configurations are in the keycloak/values.yaml file.
+
+Base configuration your endpoint will be `https://meinewaldki.anhalt.ai/dev-auth`.
+
+To uninstall keycloak run the following command:
+
+```bash
+helm uninstall test-keycloak --namespace citizen-scientist-app
+```
+
+#### Settings
+
+Log into keycloak with the following credentials:
+
+```
+Username: admin-dev
+Password: PLS_CHG_ME
+```
+
+Add a new realm for guest users.
+
+In the new realm create a new client with the ClientID `MeineWaldKIApp`.
+Enable OAuth 2.0 Device Authorization Grant.
+
+After creating the client change the following settings:
+
+Origin: `*` (should be more restrictive in production, but did not check if this works with a more restrictive setting)
+Valid Redirect URIs: `*` (should be more restrictive in production, but did not check if this works with a more restrictive setting)
+
+Add the role `guest` to the client roles.
+
+Go to Realm Settings. Set SSO Session Idle very high and SSO Session also very high (Sessions).
+
+Set Access Token Lifespan to a very high value (Tokens).
+
+Remove the first name and last name from the required user attributes (User profile).
+
+
+### Installation Rest Service
+
+I will add the automatic deployment through CI/CD later.
+
+The deployment helm is mostly written but the Docker image is not yet in a registry.
+
+
+## Run locally
+After Installing keycloak and creating your realms and changing the admin password and or admin user you can run the service locally.
+
+Add the following environment variables to your .env file:
+
+```env
+KEYCLOAK_SERVER_URL=https://meinewaldki.anhalt.ai/dev-auth/ (if not changed)
+ADMIN_USERNAME=admin_dev (if not changed)
+ADMIN_PASSWORD=PLS_CHG_ME (if not changed)
+ADMIN_REALM_NAME=master (if not changed)
+GUEST_USER_REALM_NAME=YourRealm (I set it to guest-users)
+```
+
+Mark the src directory as source root in your IDE.
+
+Run the main.py file with the working directory set to the root directory of the project.
+
+### Endpoints
+I did not setup an endpoint for cookies. This should make it easier to test the endpoints.
+
+http://127.0.0.1:5001/citizen-api/guest-user/create -> Create a new guest user
+http://127.0.0.1:5001/citizen-api/guest-user/check -> Check if Token is valid (Post request)
+http://127.0.0.1:5001/citizen-api/docs -> Swagger UI (Easy to test the endpoints)

basic_python_project-0.0.0/src/basic_python_project.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+src/basic_python_project.egg-info/PKG-INFO
+src/basic_python_project.egg-info/SOURCES.txt
+src/basic_python_project.egg-info/dependency_links.txt
+src/basic_python_project.egg-info/requires.txt
+src/basic_python_project.egg-info/top_level.txt
+src/meinewaldki_citizen_rest_service/__init__.py
+src/meinewaldki_citizen_rest_service/constants.py
+src/meinewaldki_citizen_rest_service/dependencies.py
+src/meinewaldki_citizen_rest_service/keycloak_clients.py
+src/meinewaldki_citizen_rest_service/main.py
+src/meinewaldki_citizen_rest_service/minio_client.py
+src/meinewaldki_citizen_rest_service/database/__init__.py
+src/meinewaldki_citizen_rest_service/database/engine.py
+src/meinewaldki_citizen_rest_service/database/models.py
+src/meinewaldki_citizen_rest_service/routers/__init__.py
+src/meinewaldki_citizen_rest_service/routers/guest_user_access.py
+src/meinewaldki_citizen_rest_service/routers/records.py
+src/meinewaldki_citizen_rest_service/routers/users.py
+src/meinewaldki_citizen_rest_service/schemas/__init__.py
+src/meinewaldki_citizen_rest_service/schemas/citizen_science.py
+src/meinewaldki_citizen_rest_service/schemas/image.py
+src/meinewaldki_citizen_rest_service/schemas/record.py
+src/meinewaldki_citizen_rest_service/schemas/user.py

basic_python_project-0.0.0/src/basic_python_project.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

basic_python_project-0.0.0/src/basic_python_project.egg-info/requires.txt

@@ -0,0 +1,15 @@
+fastapi~=0.115.5
+pytest~=8.3
+pytest-asyncio~=0.24
+starlette~=0.41.3
+uvicorn~=0.32.1
+python-keycloak~=4.7.3
+python-dotenv~=1.0.1
+sqlmodel~=0.0.34
+sqlalchemy~=2.0
+asyncpg~=0.30.0
+geoalchemy2~=0.15.2
+minio~=7.2
+Pillow~=11.0
+python-multipart~=0.0.20
+sentry-sdk[fastapi]~=2.0

basic_python_project-0.0.0/src/basic_python_project.egg-info/top_level.txt

@@ -0,0 +1 @@
+meinewaldki_citizen_rest_service

basic_python_project-0.0.0/src/meinewaldki_citizen_rest_service/constants.py

@@ -0,0 +1,55 @@
+"""Constants for the MeineWaldKI Citizen REST Service."""
+
+import os
+
+from dotenv import load_dotenv
+
+if os.path.exists(".env"):
+    load_dotenv(dotenv_path=".env")
+
+KEYCLOAK_SERVER_URL = os.environ["KEYCLOAK_SERVER_URL"]
+# Optional path to a CA cert for Keycloak TLS verification.
+# Set in dev when using a self-signed cert. Leave unset in production.
+KEYCLOAK_CERT_PATH = os.environ.get("KEYCLOAK_CERT_PATH")
+
+GUEST_ADMIN_USERNAME = os.environ["GUEST_ADMIN_USERNAME"]
+GUEST_ADMIN_PASSWORD = os.environ["GUEST_ADMIN_PASSWORD"]
+GUEST_ADMIN_REALM_NAME = os.environ["GUEST_ADMIN_REALM_NAME"]
+
+REGISTERED_ADMIN_USERNAME = os.environ["REGISTERED_ADMIN_USERNAME"]
+REGISTERED_ADMIN_PASSWORD = os.environ["REGISTERED_ADMIN_PASSWORD"]
+REGISTERED_ADMIN_REALM_NAME = os.environ["REGISTERED_ADMIN_REALM_NAME"]
+
+GUEST_USER_REALM_NAME = os.environ["GUEST_USER_REALM_NAME"]
+REGISTERED_USER_REALM_NAME = os.environ["REGISTERED_USER_REALM_NAME"]
+
+CLIENT_NAME = "MeineWaldKIApp"
+
+DB_USER = os.environ.get("DB_USER", "")
+DB_PASSWORD = os.environ.get("DB_PASSWORD", "")
+DB_HOST = os.environ.get("DB_HOST", "")
+DB_PORT = os.environ.get("DB_PORT", "5432")
+DB_NAME = os.environ.get("DB_NAME", "")
+
+MINIO_ENDPOINT = os.environ["MINIO_ENDPOINT"]
+MINIO_ACCESS_KEY = os.environ["MINIO_ACCESS_KEY"]
+MINIO_SECRET_KEY = os.environ["MINIO_SECRET_KEY"]
+MINIO_BUCKET = os.environ["MINIO_BUCKET"]
+MINIO_SECURE = os.environ.get("MINIO_SECURE", "true").lower() == "true"
+
+# GlitchTip / Sentry DSN — leave unset to disable error reporting
+GLITCHTIP_DSN = os.environ.get("GLITCHTIP_DSN")
+
+# EPSG:4326 — World Geodetic System 1984. Lat/lon in decimal degrees on the
+# WGS 84 ellipsoid; the reference system behind GPS and most web maps.
+WGS84_SRID = 4326
+
+ALLOWED_IMAGE_MIME_TYPES = frozenset(
+    {
+        "image/jpeg",
+        "image/png",
+        "image/webp",
+        "image/heic",
+        "image/heif",
+    }
+)

basic_python_project-0.0.0/src/meinewaldki_citizen_rest_service/database/engine.py

@@ -0,0 +1,35 @@
+from collections.abc import AsyncGenerator
+from urllib.parse import quote_plus
+
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
+from meinewaldki_citizen_rest_service.constants import (
+    DB_HOST,
+    DB_NAME,
+    DB_PASSWORD,
+    DB_PORT,
+    DB_USER,
+)
+
+_DATABASE_URL = (
+    f"postgresql+asyncpg://{quote_plus(DB_USER)}"
+    f":{quote_plus(DB_PASSWORD)}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
+)
+
+engine = create_async_engine(_DATABASE_URL, echo=False, pool_pre_ping=True)
+
+SessionLocal = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_session() -> AsyncGenerator[AsyncSession, None]:
+    """Yields an async database session for use as a FastAPI dependency.
+
+    Yields:
+        An async SQLAlchemy session that is automatically rolled back on error.
+    """
+    async with SessionLocal() as session:
+        try:
+            yield session
+        except Exception:
+            await session.rollback()
+            raise