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.10.0.tar.gz (24.2 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.10.0-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.10.0.tar.gz
  • Upload date:
  • Size: 24.2 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.10.0.tar.gz
Algorithm Hash digest
SHA256 ade88891ae5ff25e75e464532412da496aa7d3a64c6240853152fcf99e06e0e2
MD5 7efc2e0eb3f288d7f50d78bf57a42968
BLAKE2b-256 9b59536c63ef5728a8e5056c1e4f82b22132e4be5601406326a4b3e11fcd06f4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6eacdbf040ef497d1c24b6d00729c508d78689daa3ff291daf38ef0a22a6e470
MD5 81376816b01ab7f6fa26e7e40dab21e3
BLAKE2b-256 065a6e9e60bbc11ebaf059901fd77e4397727092205a0b70fe74640194d7cd51

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