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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.15.0.tar.gz
  • Upload date:
  • Size: 27.0 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.15.0.tar.gz
Algorithm Hash digest
SHA256 63b225cd0acfa619ce648524a787ca18f9c0f7f25ccd9b8218bff7143f9b6b18
MD5 481524d8f8061e97b23aa5b94227ddb4
BLAKE2b-256 0a1ba187ffbfd729c91401f242314f67a7c00ddcdd79ba8746575cecad18365c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed1f1f58de6db6305b9528b7c828282dbed696b9dc5fbc14db7d276f9620e701
MD5 0a465c6578e7da471324504474ea1469
BLAKE2b-256 481f3d64c20b795cdae5bdbeb1f6ac1d88e65082f07099f3187ed2d01dee396d

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