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.22.0.tar.gz (32.4 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.22.0-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.22.0.tar.gz
  • Upload date:
  • Size: 32.4 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.22.0.tar.gz
Algorithm Hash digest
SHA256 5ec85dfaa9dc32a5481b6bac4ae4a6b4a4081174e6d67dd55535253aaa2bfbec
MD5 e8e03fd8005440df402b8b75e9f794a9
BLAKE2b-256 56c092e404f1cce602e128497694a1f70eb82baa80e51f5fc5129f372eb7ede2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8db33b5855d31e6a954f3fce3148c29c403dd8b1d72f1e1b06fc2b1d0666d044
MD5 728a61943bb09c29e024685677d6350e
BLAKE2b-256 296aeac3f6e0367d70656146b19ab4007f6125730b03714168ed271e1090de15

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