add requirements, update documentation

config/config.py

@@ -132,7 +132,8 @@ class Config:
         if self._config is None:
             raise RuntimeError("Configuration not loaded")
         omegaconf.OmegaConf.save(self._config, "config/settings.yaml")
-    def apply_options(options:list):
+        
+    def apply_options(self, options:list):
         if self._config is None:
             raise RuntimeError("Configuration not loaded")
         for option in options:
@@ -148,6 +149,13 @@ class Config:
     def updateValue(self, key:str, value):
         if self._config is None:
             raise RuntimeError("Configuration not loaded")
+        if "." in key:
+            keys = key.split(".")
+            if keys[0] in self._config:
+                self._config[keys[0]][keys[1]] = value
+            else:
+                raise KeyError(f"Option {keys[0]} not found in configuration")
+        else:
             self._config[key] = value
 if __name__ == "__main__":
     cfg = Config("config/settings.yaml")

docs/Ausleihsystem.md

@@ -19,7 +19,7 @@ Der Bereich beschränkt sich auf folgende Inhalte:
 
 Hier werden folgende Daten angezeigt
 
-- Modus: entweder "Ausleihe" oder "Rückgabe" (1)
+- Modus: entweder "Ausleihe" oder "Rückgabe" (1) Kann entweder durch anklicken des Knopfes oder mit dem Shortcut (Standard: `F5`) geändert werden
 - Matrikelnummer: die Matrikelnummer des Nutzers, um das Konto zu öffnen (3)
 - Benutzername: der Benutzername des Nutzers (3)
 - Signatur: die Signatur des Mediums, welches entliehen oder zurückgegeben wird (4)
@@ -43,5 +43,37 @@ Dieser Bereich beschränkt sich auf folgende Inhalte:
 ### Historie (7)
 Das Feld der Historie listet alle Medien auf, die im aktiven Prozess ausgeliehen oder zurückgegeben wurden. 
 
+## Ausleihen
+
+Um ein Medium auszuleihen, muss zuerst ein Nutzer geöffnet sein. Dazu entweder den Knopf neben Modus drücken, oder den Shortcut (Standard: `F5`) verwenden.
+Die Oberfläche sieht dann wie folgt aus:
+
+![Ausleihe](images/main_loan_active.png)
 
 
+Der Cursor wird automatisch auf die Matrikelnummer gesetzt. Hier kann entweder die vollständige Nummer, oder ein Teil eingegeben werden. Sollten mehrere Nummern dem Teilfilter ensprechen, wird eine Auswahl angezeigt. (s. [MultiUser](MultiUser.md))
+Nach der Auswahl wird das entsprechende Konto geöffnet und die Ausleihe kann durchgeführt werden.
+
+![Ausleihe](images/activeLoan.png)
+
+
+Sollte der aktive Nutzer aktive Ausleihen haben, so wird die Anzahl der Medien neben "Anzahl Ausleihen" angezeigt. Das nächste Rückgabedatum wird ebenfalls angezeigt. Über einen Klick auf die Zahl der Ausleihen gelangen Sie zur [Übersicht der Ausleihen des Nutzers](Nutzeroberfläche.md).
+
+Um ein Medium auszuleihen, muss die Signatur in die entsprechende Zeile eingegeben werden. Sollte die Signatur nicht in der Datenbank existieren, wird der definierte Katalog geprüft. Wird das Medium gefunden, wird es in die Datenbank übernommen und die Ausleihe wird durchgeführt. Sollte das Medium nicht gefunden werden, wird eine Fehlermeldung angezeigt.
+
+![FehlerAusleihe](images/err_noBook.png)
+
+!!! info
+
+    Die Signatur muss mindestens ein Leerzeichen enthalten, ansonsten wird eine Fehlermeldung angezeigt.
+
+## Rückgaben
+
+!!! info
+    Rückgaben funktionieren nur, wenn kein Nutzer offen ist. Vor einer Rückgabe bitte sicherstellen, dass der Modus auf "Rückgabe" gesetzt ist.
+
+Um ein Medium zurückzugeben, muss die Signatur in die entsprechende Zeile eingegeben werden. Sollte die Signatur nicht existieren, wird eine Fehlermeldung angezeigt.
+
+![FehlerRückgabe](images/err_return.png)
+
+Existiert das Medium in der Datenbank und ist entliehen, wird die Rückgabe durchgeführt. Die Rückgabe wird in der Historie gespeichert und das Medium wird wieder als verfügbar markiert. Die Daten des Nutzers werden in der Oberfläche angezeigt.

docs/MultiUser.md

@@ -0,0 +1,5 @@
+# Mehrere Nutzer gefunden
+![Mehrere Nutzer gefunden](images/multiUser.png)
+
+!!! info
+    Es wurden mehrere Nutzer gefunden, die auf die Suchanfrage passen. Bitte wählen Sie einen Nutzer aus der Liste aus, und bestätigen Sie mit `OK`.

docs/Nutzeroberfläche.md

@@ -14,7 +14,7 @@
 
 - (2) Nutzer Löschen:
 
-    Mit dem Klick auf den Mülleimer wird der Nutzer gelöscht. Alle zugewiesenen Ausleihen werden in der [Ausleihhistorie](Ausleihhistorie.md) mit den Nutzerkonto `gelöscht` angezeigt.
+    Mit dem Klick auf den Mülleimer wird der Nutzer gelöscht. Alle zugewiesenen Ausleihen werden in der [Ausleihhistorie](Ausleihhistorie.md) mit den Nutzerkonto `gelöscht` angezeigt. Diese Option ist nur vorhanden, wenn keine Ausleihen aktiv sind.
 
 - (4) Medien: 
   

docs/index.md

@@ -11,10 +11,11 @@ Von hier aus können Nutzer angelegt und bearbeitet werden, Medien ausgeliehen u
 
 Unterbereiche umfassen:
 
+- [Hauptoberfläche](Ausleihsystem.md)
 - [Nutzerdaten](Nutzeroberfläche.md) - Daten für den aktuellen Nutzer anzeigen und bearbeiten
 - [Nutzer anlegen](Nutzer anlegen.md) - Neuen Nutzer anlegen
 - [Ausleihhistorie](Ausleihhistorie.md) - Historie der Ausleihen
 - [Bericht erstellen](Bericht erstellen.md) - Bericht für einen festgelegten Zeitrahmen erstellen
-- [Einstellungen](Einstellungen.md)
+- [Einstellungen](Einstellungen.md) - Einstellungen der Anwendung ändern
+
 
-## Navigation