diff --git a/README.md b/README.md index ec6eff0d211a012eb01cebc54cf696857962e4bb..247a98f9c851ca1ebacca18a3b1e7723c789a0ac 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ +<!-- START doctoc generated TOC please keep comment here to allow auto update --> +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> + + +- [sams_classes](#sams_classes) + - [Installation](#installation) + - [Klassen](#klassen) + - [SAMSHub](#samshub) + - [Methoden](#methoden) + - [Eigenschaften](#eigenschaften) + - [SAMSApp](#samsapp) + - [Methoden](#methoden-1) + - [Eigenschaften](#eigenschaften-1) + - [SAMProxy](#samproxy) + - [Methoden](#methoden-2) + - [Eigenschaften](#eigenschaften-2) + +<!-- END doctoc generated TOC please keep comment here to allow auto update --> + # sams_classes Dieses Python3 Modul stellt die Grundlage für die Implementierung von @@ -5,6 +24,18 @@ Applicationservern in der Selve-/ Administravie-Microservice-Structure dar. Das Künftige MIPortal, ZID und andere Anwendungen sollen diese Klassen verwenden verwenden können. +## Installation + +Den Gewünschten Build über [Pipelines](https://git.imp.fu-berlin.de/slobinger/sams-classes/pipelines) herunterladen. +Die interessanten Builds sind immer die vom Job 'test_and_Deploy_tags' + +```bash +unzip artifacts.zip +scp build/python3-sams-classes_<VERSION>_all.deb <USER>@<ZIELHOST>: +ssh <USER>@<ZIELHOST> +gdebi python3-sams-classes_<VERSION>_all.deb +``` + ## Klassen Derzeit enthält die Bibliothek drei Klassen @@ -273,4 +304,4 @@ die eigendliche Proxy aufgabe, wenn eine Anfrage durch sie behandelt wird. ##### urlRule Flask kompatible urlRule für den Proxy. Zur verwendung mit -```flask_app.register_url``` \ No newline at end of file +`flask_app.register_url`