orchestra-sdk

What it is and what it does

Orchestra SDK is a client library that bridges self-hosted task execution environments with the Orchestra workflow orchestration platform. It handles the HTTP communication needed for a task running outside Orchestra's control to report its progress, completion status, logs, and output values back to the platform. The SDK provides both a decorator pattern for automatic lifecycle tracking (sending RUNNING on start, SUCCEEDED or FAILED on completion) and manual methods for fine-grained control over status updates and output setting.

The package is designed for integration into task code that Orchestra triggers asynchronously—typically in self-hosted servers, containers, or AWS Lambda functions. It requires an API key for authentication and a task run ID (usually set by Orchestra as an environment variable) to route updates to the correct workflow execution. Optional log file sending and AWS Lambda-specific configuration helpers reduce boilerplate for common deployment patterns.

Use it for:

• Wrap a long-running self-hosted task with the @orchestra.run() decorator to automatically report start, completion, and failure to Orchestra.
• Send intermediate status messages and logs from a task back to Orchestra for visibility into execution progress.
• Set task output values (e.g., result of a computation) that downstream workflow steps can consume.
• Configure a Lambda function handler to extract Orchestra metadata from the event and apply it to the SDK instance.
• Manually control task status updates in complex workflows where decorator automation is insufficient.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A lightweight SDK for self-hosted tasks to send status updates, logs, and outputs back to Orchestra via HTTP, with decorator support for automatic lifecycle management.

Yes, if you are running self-hosted tasks orchestrated by Orchestra and need to report their status and logs back to the platform. The low install friction and permissive license make adoption straightforward. However, the aging maintenance status (261 days since last release) suggests you should verify that the SDK remains compatible with your Orchestra version and that the project is not in hibernation before committing to production use.

Install

orchestra-sdk on PyPI

pip install orchestra-sdk

uv add orchestra-sdk

poetry add orchestra-sdk

Installing orchestra-sdk

Before you install

Low install friction with only two runtime dependencies (requests, tenacity). Maintenance status is aging—last release was 261 days ago—so expect slower response to issues or feature requests.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for commercial and open-source projects alike.

Quickstart

pip install orchestra-sdk

from orchestra_sdk.orchestra import OrchestraSDK

orchestra = OrchestraSDK(api_key="your_api_key")

@orchestra.run()
def my_task():
    print("Task running")
    return "result"

Requires ORCHESTRA_TASK_RUN_ID environment variable (set by Orchestra) or manual assignment after initialization; API key must be provided or available via environment.

Verify before relying

• Whether the package is actively maintained or in maintenance-only mode despite the aging status.
• Compatibility with Orchestra versions beyond what the SDK was released against.
• Performance characteristics when sending large log files or frequent status updates.

Package facts

Evidence: orchestra_sdk-0.1.2-py3-none-any.whl

Keywords: python, logging, data, orchestration

Tags

More Database packages