Skip to main content

Python SDK for Kestrel Workflows

Project description

Kestrel SDK

Python SDK for Kestrel — AI Agents for Cloud Operations.

Build, deploy, and manage workflows programmatically with a typed, fluent API.

Installation

pip install kestrel-workflows

Quick Start

from kestrel import KestrelClient
from kestrel.workflows import Workflow, Trigger, Action

client = KestrelClient(api_key="kestrel_sk_...")

wf = (
    Workflow("Pod Crash RCA + Jira")
    .description("Run RCA on pod crash, create Jira ticket")
    .trigger(
        Trigger.k8s_pod_status()
        .reasons("CrashLoopBackOff")
        .namespace("production")
    )
    .cooldown(hours=24)
    .then(Action.kestrel_trigger_rca().label("Run RCA"))
    .then(Action.jira_create_ticket()
        .project("KAN")
        .title("{{incident.title}}")
        .priority("High")
    )
)

created = client.workflows.deploy(wf, activate=True)
print(f"Deployed: {created.id}")

Async Support

from kestrel import AsyncKestrelClient

async with AsyncKestrelClient(api_key="kestrel_sk_...") as client:
    workflows = await client.workflows.list()
    execution = await client.workflows.test(workflows[0].id)
    result = await client.executions.wait(execution.id)
    print(f"Result: {result.status}")

Authentication

Create an API key in the Kestrel platform under Workflows > API Keys.

# API key (recommended)
client = KestrelClient(api_key="kestrel_sk_...")

# From CLI login
client = KestrelClient.from_config()

# Async
client = AsyncKestrelClient(api_key="kestrel_sk_...")

Documentation

Full SDK documentation: docs.usekestrel.ai/workflows/sdk

License

Apache 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kestrel_workflows-0.14.0.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kestrel_workflows-0.14.0-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

Details for the file kestrel_workflows-0.14.0.tar.gz.

File metadata

  • Download URL: kestrel_workflows-0.14.0.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kestrel_workflows-0.14.0.tar.gz
Algorithm Hash digest
SHA256 d686b1343d301b281951f62799aa7a32e9c54674371a57263a07f5176bcd625e
MD5 6ee7e95e988f35cd848c7920e1f9fb82
BLAKE2b-256 b18ee20250c6b4acb9ea92b5af5ce33dea9143cdb2f52f9fd2ee948918b9ffe1

See more details on using hashes here.

File details

Details for the file kestrel_workflows-0.14.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kestrel_workflows-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44736f7bbe1783ae4c09dc782cbdf650e6b67bd6e0953a9a350d10d34aa78a3a
MD5 178d4a24725ae66ecf2a03ca9189a44c
BLAKE2b-256 ddeadfc9082397806e364f19f902de1d72a0da44fd72c8ad510ca26e8d8d4f20

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page