Orchestra Python SDK
This is a lightweight SDK that allows Orchestra to interact with self-hosted applications (Tasks).
The basic premise is for your self-hosted Task to send back status updates and logs to Orchestra. This is done via HTTP requests. The Task is started by Orchestra.
Guide
Firstly, install the package:
pip install orchestra-sdk
The package requires the following environment variable to be set manually:
ORCHESTRA_API_KEY: The API key to connect to Orchestra. This can be found in your settings page.
Orchestra will automatically set the following environment variables when the Task is triggered:
ORCHESTRA_WEBHOOK_URL: The URL to send status updates toORCHESTRA_TASK_RUN_ID: The UUID of the Task being executedORCHESTRA_PIPELINE_RUN_ID: The UUID of the Pipeline Run that the Task is part of
To use the package in your code:
from orchestra_sdk.decorators import orchestra_run
@orchestra_run
def my_function(arg1, arg2=1):
print("Running complex process")
Summary
- The decorator will firstly read and validate the environment variables
- It will send a
RUNNINGstatus update to Orchestra - Your function will then run
- If an exception is raised, the decorator will send a
FAILEDstatus update to Orchestra - If the function finishes without an error being raised, regardless of the return value, the decorator will send a
SUCCEEDEDstatus update to Orchestra
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file orchestra_sdk-0.0.14.tar.gz.
File metadata
- Download URL: orchestra_sdk-0.0.14.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
beac5b107d8fcaa99bb3da97c3c61644e0a3e3222cd16824b638f5d10e219969
|
|
| MD5 |
11adf71d9ebc162ddb35c1eca0df0a22
|
|
| BLAKE2b-256 |
16a1256d1f08cf0da6b6b32e5749bd039859e7451f95dfdeccc9fcfef25c1aa3
|
File details
Details for the file orchestra_sdk-0.0.14-py3-none-any.whl.
File metadata
- Download URL: orchestra_sdk-0.0.14-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
16546a766790911dcff5f06f4a7bfd6f83b3afcf9ae240c378cde14230649713
|
|
| MD5 |
a8180c1d8e9a8de94e7662c3906bbc56
|
|
| BLAKE2b-256 |
6c890cc1c37f3c44626938f4a16a08074bc307ce4e48b645e0597aaa9ff1fff0
|
