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.27.0.tar.gz (42.8 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.27.0-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.27.0.tar.gz
  • Upload date:
  • Size: 42.8 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.27.0.tar.gz
Algorithm Hash digest
SHA256 98191579f19c415771a6658e3f744d0c2368d25d6b68e5645a02b3b12623c808
MD5 9cbb744e663bf4324378d1780347d573
BLAKE2b-256 db5a95bb1b5c07a6904c6ea79f34819936b0e5bb1068b97544a8ef56bc39525d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.27.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7a67066eaa035e7d508e0acbdd0e754089e6479c04b9ef9ce0fc21f441735ee7
MD5 ac75b609d78764939e87945c222f75c3
BLAKE2b-256 3646fad03673c45dbc990e90c205e54a10d6494e1824345a682617370728a863

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