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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.12.0.tar.gz
  • Upload date:
  • Size: 24.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.12.0.tar.gz
Algorithm Hash digest
SHA256 ed5af4648ec891e75a0e6d010ba0b0a6fca05ad2002cd8550e6eaf129d00eae8
MD5 b2c8262bab6fff8906c95ea5704926e4
BLAKE2b-256 80674c3c4d05d0d5a4e7cac728e9e31acb4f929332e7f5ce0c883b0d4189e9df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50a8052de5bcc5f73459db0491c0ccf736a775c811debe6a4afb1b988fe7b614
MD5 64d327762fd75fd611dbe79d61b0b185
BLAKE2b-256 7d6c3cecd047cc3960f44caa9c4800c228cbba095540018b34eeb00acc80f36a

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