# SDK für den ProcessCube
Werkzeuge und Tools für die Entwicklung mit dem ProcessCube
## Unterstützung
Moduleliste:
- processcube_sdk.configuration: Umgang mit Konfigurationsdateien
- processcube_sdk.database: Datenbankzugriffe mit SQLAlchemy und Pandas handeln
- processcube_sdk.external_tasks: External-Tasks-Basis-Klassen und generische Umsetzung (z.B. Prüfen von Instanzen eines Models)
- processcube_sdk.fastapi: fastapi-Auth-Module für den Umgang mit Google-Authentifizierung
- processcube_sdk.jupyter: Vereinfachung der automatischen Ausführung von Jupyter-Notebooks und Ergebnissen, die als Resultat ermittelt werden sollen
## Verwendung
### processcube_sdk.external_tasks
Die External-Tasks haben für die direkte Verwendung eine Möglichekeit als Module direkt gestartet zu werden.
Das Starten erfolgt wie nachfolgende beschrieben:
```shell
python -m pip install processcube_sdk
CONFIG_FILE=`pwd`/config.dev.json PYTHONPATH=. python -m processcube_sdk.external_tasks
```
Die Konfigurationsdatei, sollte dabei folgende Elemente enthalten:
```json
{
"engine":
{
"url": "http://192.168.178.125:56100"
},
"logging":
{
"level": "info"
},
"external_task_worker": {
"authority_url": "http://localhost:56000",
"client_name": "processcube_external_tasks",
"client_secret": "RyxBOlzo4pVQZZ6EzKnjRyxBOlzo4pVQZZ6EzKnjRyxBOlzo4pVQZZ6EzKnjRyxBOlzo4pVQZZ6EzKnj",
"client_scopes": "engine_etw",
"max_get_access_token_retries": 10
}
}
```
Zur Authorisierung der External-Tasks gegen die Engine ist es notwendig den Eintrag "external_task_worker" mit den Einträgen:
- authority_url: Authority, die den Token ausstellt
- client_name: Unter welchem Namen die External-Tasks der Authority bekannt sind
- client_secret: Secret, welches zur Authentifizierung der External-Tasks benötigt wird
- client_scopes: Welche Berechtigungen die External-Tasks haben sollen
zu erstellen.
#### Verwendung mit Docker
Die Verwendung mit Docker ist unter docs/README.Dockerfile.md beschrieben.
Raw data
{
"_id": null,
"home_page": "https://github.com/5minds/processcube_sdk.py",
"name": "processcube-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sdk processcube bpmm external-tasks process-management etw",
"author": "5Minds IT-Solutions GmbH & Co. KG",
"author_email": "processcube@5minds.de",
"download_url": "https://files.pythonhosted.org/packages/47/1d/f7e45e4442af9956cbbdcf1ca21c483bfc83bbd406cd1635e0d1f41914aa/processcube_sdk-5.0.3.tar.gz",
"platform": null,
"description": "# SDK f\u00fcr den ProcessCube\n\nWerkzeuge und Tools f\u00fcr die Entwicklung mit dem ProcessCube\n\n## Unterst\u00fctzung\n\nModuleliste:\n- processcube_sdk.configuration: Umgang mit Konfigurationsdateien\n- processcube_sdk.database: Datenbankzugriffe mit SQLAlchemy und Pandas handeln\n- processcube_sdk.external_tasks: External-Tasks-Basis-Klassen und generische Umsetzung (z.B. Pr\u00fcfen von Instanzen eines Models)\n- processcube_sdk.fastapi: fastapi-Auth-Module f\u00fcr den Umgang mit Google-Authentifizierung\n- processcube_sdk.jupyter: Vereinfachung der automatischen Ausf\u00fchrung von Jupyter-Notebooks und Ergebnissen, die als Resultat ermittelt werden sollen\n\n\n## Verwendung\n### processcube_sdk.external_tasks\n\nDie External-Tasks haben f\u00fcr die direkte Verwendung eine M\u00f6glichekeit als Module direkt gestartet zu werden.\n\nDas Starten erfolgt wie nachfolgende beschrieben:\n\n```shell\npython -m pip install processcube_sdk\n\n\nCONFIG_FILE=`pwd`/config.dev.json PYTHONPATH=. python -m processcube_sdk.external_tasks\n```\n\nDie Konfigurationsdatei, sollte dabei folgende Elemente enthalten:\n```json\n{\n \"engine\": \n {\n \"url\": \"http://192.168.178.125:56100\"\n },\n \"logging\": \n {\n \"level\": \"info\"\n },\n \"external_task_worker\": {\n \"authority_url\": \"http://localhost:56000\",\n \"client_name\": \"processcube_external_tasks\",\n \"client_secret\": \"RyxBOlzo4pVQZZ6EzKnjRyxBOlzo4pVQZZ6EzKnjRyxBOlzo4pVQZZ6EzKnjRyxBOlzo4pVQZZ6EzKnj\",\n \"client_scopes\": \"engine_etw\",\n \"max_get_access_token_retries\": 10\n }\n\n}\n```\n\nZur Authorisierung der External-Tasks gegen die Engine ist es notwendig den Eintrag \"external_task_worker\" mit den Eintr\u00e4gen:\n- authority_url: Authority, die den Token ausstellt\n- client_name: Unter welchem Namen die External-Tasks der Authority bekannt sind\n- client_secret: Secret, welches zur Authentifizierung der External-Tasks ben\u00f6tigt wird\n- client_scopes: Welche Berechtigungen die External-Tasks haben sollen\n\nzu erstellen.\n\n#### Verwendung mit Docker\n\nDie Verwendung mit Docker ist unter docs/README.Dockerfile.md beschrieben.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Some tools and defaults to program for the ProcessCube.",
"version": "5.0.3",
"project_urls": {
"Homepage": "https://github.com/5minds/processcube_sdk.py"
},
"split_keywords": [
"sdk",
"processcube",
"bpmm",
"external-tasks",
"process-management",
"etw"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8bc3fce00355a94a5ecb52234284c9b4e63539d4f67ef631daae52bb5ba1d3a",
"md5": "b5481b3ca50b5aa2814fd5647cb3ca89",
"sha256": "e891bf9f4366aa7e33bbfcb1c06538317ebe726e94cdc7f29e5b1960806fcd08"
},
"downloads": -1,
"filename": "processcube_sdk-5.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5481b3ca50b5aa2814fd5647cb3ca89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 24084,
"upload_time": "2024-12-03T20:34:05",
"upload_time_iso_8601": "2024-12-03T20:34:05.668987Z",
"url": "https://files.pythonhosted.org/packages/c8/bc/3fce00355a94a5ecb52234284c9b4e63539d4f67ef631daae52bb5ba1d3a/processcube_sdk-5.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "471df7e45e4442af9956cbbdcf1ca21c483bfc83bbd406cd1635e0d1f41914aa",
"md5": "b0ae6256e3be8c7cedf57e1cede2b0d3",
"sha256": "e04092490cd3a541da71bf1823e978075ff5bc90cd0b39c416c2c7983131aec5"
},
"downloads": -1,
"filename": "processcube_sdk-5.0.3.tar.gz",
"has_sig": false,
"md5_digest": "b0ae6256e3be8c7cedf57e1cede2b0d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18307,
"upload_time": "2024-12-03T20:34:07",
"upload_time_iso_8601": "2024-12-03T20:34:07.388264Z",
"url": "https://files.pythonhosted.org/packages/47/1d/f7e45e4442af9956cbbdcf1ca21c483bfc83bbd406cd1635e0d1f41914aa/processcube_sdk-5.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 20:34:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "5minds",
"github_project": "processcube_sdk.py",
"github_not_found": true,
"lcname": "processcube-sdk"
}
JSON
