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.21.0.tar.gz (31.5 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.21.0-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.21.0.tar.gz
  • Upload date:
  • Size: 31.5 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.21.0.tar.gz
Algorithm Hash digest
SHA256 3378b72176f8a18589d30cc6cdfac785f93ca658161b36f35b4736e092c17c2b
MD5 7b510223606b16f1e51bbf9d4bb337f2
BLAKE2b-256 e8915403fb9ba901a1983746f928657a4516d43f0339e0198c2534f0f9d0048f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a7d11ad76eee1399f9d0af80808c9e2b89993097133ab74b5be09c870c3feb6
MD5 a7bc20f6135d7806e282400ff0046955
BLAKE2b-256 9fc27b2dc5fad629d186e9e3b2d42588b650fe747c0551dd6c3b06b43db3bc01

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