diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..413f529dd429bf5d16d155594a2734aa171bcb0e --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# sams-hub-creator + +Modul zum einfachen erstellen eines samsHUB basierend auf einer vorgegebenen +Verzeichnisstruktur unf Konfigurationsdateien im YAML-Format. + +## Verwendung + +Man kann das modul als python package z.B. in folgender Struktur Verwenden: +``` +projekt ++-- config +| +-- config.yaml ++-- sams_hub_creator +| +-- __init__.py +| ... ++-- app_package +| +-- __init__.py +| ... ++-- app.py +``` + +Dabei liegt diesen Projekt im Verzeichnis `sams_hub_creator`. +Ein amsHub Objektlässt sich in der app.py dann sehr einfach Erzeugen: +```python +import sams_hub_creator + +hub = sams_hub_creator.create(conf_part_hub = 'my_hub') +``` +In diesem Fall muss in der config.yaml der key für die hub konfiguration 'my_hub' +lauten. Die namen der apps, die der hub einbinden soll müssen in der config unter +'apps' stehen. Eine Config für die oben genannte Struktur könnte also so aussehen: +```yaml +zib_hub: + default_language: de + main_app: 'app_package' +apps: + - name: 'app_package' +``` + +## Verweise +Zu den möglichkeiten der samsHub Konfiguration siehe +[sams-classes](https://git.imp.fu-berlin.de/coding-at-fu/sams-classes) \ No newline at end of file diff --git a/__init__.py b/__init__.py index 48be19d1d5f3200065a9a1766f310c3dc4f82764..873ba3aed1c4d27d3a1f5c501d6cf6104ba69643 100644 --- a/__init__.py +++ b/__init__.py @@ -2,8 +2,8 @@ import yaml, os, glob from sams_classes import SAMSHub, SAMSApp from flask import Flask -def create_hub(conf_part_hub, conf_part_apps = 'apps', - config_file_path = 'config/config.yaml', dir_apps = '.'): +def create(conf_part_hub, conf_part_apps = 'apps', + config_file_path = 'config/config.yaml', dir_apps = '.'): with open(config_file_path, 'r') as f: hubConf = yaml.load(f.read()) hub = SAMSHub(name= __name__, config=hubConf[hub_conf_key]) @@ -33,8 +33,3 @@ def search_yaml_files(path, exts = ['.yaml', '.yml']): if os.path.isfile(path): matchingFiles.append(path) return matchingFiles - -if __name__ == '__main__': - create_hub() -else: - hub = create_hub()