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.16.0.tar.gz (27.9 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.16.0-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.16.0.tar.gz
  • Upload date:
  • Size: 27.9 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.16.0.tar.gz
Algorithm Hash digest
SHA256 4ead2dbfdcdc1423dd034859f60da24350a472415b1c43c827b824ed4424ccc2
MD5 f23c97adce22c7fd01b27321d53cbe32
BLAKE2b-256 651fbc1e2a9d7729d5113be29876848d24d69b6e071063350ca1521f45d2a7dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e29816e16763bb02c0c1294dc6b6c83ff4b56610275b24339e736b16bdde718b
MD5 b8827d06828aec5001cf15b0204b9697
BLAKE2b-256 75eda42b240d080a8b07fb625bfe0a7c8e0e4e3ba3a3cec2aa2cf7b5aab77496

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