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.19.0.tar.gz (30.3 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.19.0-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.19.0.tar.gz
  • Upload date:
  • Size: 30.3 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.19.0.tar.gz
Algorithm Hash digest
SHA256 439de29577a231e8912275f531f692e78af0a7c4514bd927810a190c0ad5817d
MD5 b31c8e020ee917001068b8485aa67c1f
BLAKE2b-256 22c6be8d835678e10b30de3cde1f47cb8fe750874dbb81ae4ee3bce65d8a50d4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47da6acbcabccfa4016f89684625f4262550e4aaa1540f039baf14284550fce7
MD5 567a439d20de37582367d0b55612cd3c
BLAKE2b-256 a4a6e5e607e2a1a6995a062a54018b9f07c681bc4a4110aba9a497326dd06dbf

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