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.26.0.tar.gz (41.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.26.0-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.26.0.tar.gz
  • Upload date:
  • Size: 41.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.26.0.tar.gz
Algorithm Hash digest
SHA256 30a35bd20dffc4049af53b0b566e0d22a78caf085ea307a7bdc5bd2d82deb86a
MD5 b24e00c7d20961cf634f5a46e61a1409
BLAKE2b-256 68630257f7a61937a47a75a77ff239798586e9e3d8fda21f4377ca8e9e7c503d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b37d466804c55b053deadf9ee30d483a34ab6147091065894208b1b4f648d52e
MD5 27f06ea69651101fcf107f967bfecb9e
BLAKE2b-256 4cc0460f06977fd36100e59341c3fe0060e20e522d96c85616d270bdf9e57f3b

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