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.18.0.tar.gz (29.7 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.18.0-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.18.0.tar.gz
  • Upload date:
  • Size: 29.7 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.18.0.tar.gz
Algorithm Hash digest
SHA256 887bd04c0a6743ebdba8ff4d3d2e6072777b90d021b6b1416a1c6b87bc978b0c
MD5 bd2a40fd312712498ade6adc171ada50
BLAKE2b-256 81bf916e57e4dc246c8bb33fe1e329ed02417e493419657faebf7f5583c558ed

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 04258d0e2a089e6ef95c0f400d71e1f6bf4e7d7247d1652b3708b7d99ce49a13
MD5 4e80a8a8feef0bbc1c752fb208b00154
BLAKE2b-256 f0de9d386211ac8cd0a55d7369b9c73cade4c4bb9213892734f1ab5b27bb5188

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