diff --git a/README.md b/README.md index b27944e7cb06c4306cf505b6fc45175d5de3a84a..68f319420c88cf505600b3548c2069aa475a015c 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,64 @@ sich das gesamte Wissen über Flask und alle möglichkeiten von Flask auch auf d vom SAMSHub bereitgestellte flaskApp anwenden. Der SAMSHub erledigt lediglich einige Aufgaben die so bei allen Zukünftigen Anwendungen anfallen werden. +#### Methoden + +##### Konstruktor + +```python +hub = SAMSHub(name=__name__, config = {'default_language': 'de'}) +``` +Pflichtparameter sind name und config. Das Konfigurationsdictionary muss +eine angabe tur 'default_language' beinhalten. + +##### addApp + +```python +hub.addApp(app=samsApp) +``` +Die Methode fügt dem hub eine SAMSApp hinzu. Es muss sich bei app um eine +Instanz von SAMSApp handeln. Der Name der app (app.name) wird als name für +die Ansprache mit hub.app(name) verwendet. + +##### app + +```python +samsApp = hub.app(name) +``` +Die Methode gibt die SAMSApp mit dem betreffenden Namen zurück. + +##### menu + +```python +menu = hub.menu(langCode = 'de') +``` +Gibt eine Liste mit allen Menüeinträgen aller hinzugefügter Apps in der +geforderten Sprache zurück. Falls die sprache bei einigen Einträgen +nicht verfügbar ist wird die default Sprache der App verwendet. +Die Reihenfolge der Einträge wird durch die reihenfolge, in der die Apps +hinzugefügt wurden, bestimmt. + +#### Eigenschaften + +##### appKeys + +```python +for key in hub.appKeys: + print(key + '\n') +``` +Die Methode gibt eine Liste der keys aller dem hub hinzugefügten apps aus. +Über einen Key lässt sich mit ```hub.app(key)``` die jeweilige app Instanz +zurückgeben. + +##### flaskApp + +```python +hub.flaskApp.run() +``` +Mit flaskApp lässt sich die vom hub erzeugte flask App zurückgeben und z.B. +dann über run starten. Für die flask App kann die flask Dokumentation zu Rate +gezogen werden. + ### SAMSApp **TODO**