Add a CLI to delete a user with it's profile information

Reviewed-on: #49

README.md

@@ -9,6 +9,32 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 [![Build Status](https://drone.wtf-eg.de/api/badges/kompetenzinventar/ki-backend/status.svg?ref=refs/heads/main)](https://drone.wtf-eg.de/kompetenzinventar/ki-backend)
 [![REUSE status](https://api.reuse.software/badge/git.wtf-eg.de/kompetenzinventar/ki-backend)](https://api.reuse.software/info/git.wtf-eg.de/kompetenzinventar/ki-backend)
 
+## Über
+
+Dieses Repo enthält das Backend des Projekts Kompentenzinventar - einer Webapplikation zur Erfassung von Userprofilen für die WTF eG.
+
+Implementiert ist das Backend mit Flask.
+
+### Mitmachen
+
+Du kannst gerne bei der Entwicklung des Kompetenzinventars mitmachen.
+
+- Fehler oder fehlende Funktionen erfassen. Bitte direkt über die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-backend/issues) in Gitea.
+- Dokumentation oder Implementierung verbessern. Bitte forke hierzu das Projekt, branche von `main` ab und erstelle dann einen [Pull Request](https://git.wtf-eg.de/kompetenzinventar/ki-backend/pulls).
+
+### Kommunikation
+
+Folgende Kanäle gibt es für die Kommunikation über das Kompetenzinventar:
+
+- Die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-backend/issues) im WTF Gitea.
+- Den Bereich [AG Entwicklung](https://forum.wtf-eg.de/c/interna/ag-entwicklung/21) im WTF Forum.
+- Einen Raum in Matrix. Zutritt per Einladung, frlan lädt ein, eine einfache PN im Forum reicht.
+
+### Repos
+
+* **[ki-backend](https://git.wtf-eg.de/kompetenzinventar/ki-backend)** (dieses Repo) enthält das Backend
+* [ki-frontend](https://git.wtf-eg.de/kompetenzinventar/ki-frontend) enthält das Frontend
+* Weitere Repositories befinden sich in der Gitea Organisation [Kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar).
 ## Entwicklung
 
 ### Abhängigkeiten

ki/actions/__init__.py

@@ -3,3 +3,4 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 from ki.actions.seed import seed  # noqa
+from ki.actions.delete_profile import delete_profile  # noqa

ki/actions/delete_profile.py

@@ -0,0 +1,52 @@
+# SPDX-FileCopyrightText: WTF Kooperative eG <https://wtf-eg.de/>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from sqlalchemy.exc import NoResultFound
+from app import app, db
+from ki.models import User
+import sys
+
+
+def delete_profile(nickname: str):
+
+    # Getting the user
+    try:
+        user = User.query.filter(User.auth_id.__eq__(nickname)).one()
+    except NoResultFound:
+        sys.exit(f'Username »{nickname}« not found')
+
+    app.logger.info(f'Starting to delete user »{nickname}.')
+
+    # Deleting associated languages skills
+    try:
+        for language in (user.profile.languages):
+            print(language.language_id)
+            app.logger.info(f'Deleting language skil »{language.language_id}« for »{nickname}«.')
+            db.session.delete(language)
+            db.session.commit()
+    except AttributeError:
+        # No languages left over
+        pass
+
+    # Deleting associated skills
+    try:
+        app.logger.info(f'Deleting skils for »{nickname}«.')
+        for skill in user.profile.skills:
+            db.session.delete(skill)
+            db.session.commit()
+    except AttributeError:
+        # No skills left over
+        pass
+
+    # Cleaning up profile
+    try:
+        app.logger.info(f'Deleting profile for »{nickname}«.')
+        db.session.delete(user.profile)
+    except:
+        # No profile to be deleted
+        pass
+    # Deleting the user
+    app.logger.info(f'Delete user »{nickname}«.')
+    db.session.delete(user)
+    db.session.commit()

ki/commands.py

@@ -6,9 +6,19 @@ import click
 
 from app import app
 from ki.actions import seed
+from ki.actions import delete_profile
 
 
 @app.cli.command("seed")
 @click.option("--dev", is_flag=True)
 def seed_command(dev):
     seed(dev)
+
+
+@app.cli.command("delete", help="Delete a user profile")
+@click.option(
+    "--profile",
+    help="Username of profile",
+)
+def delete_command(profile):
+    delete_profile(profile)