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.20.0.tar.gz (31.0 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.20.0-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.20.0.tar.gz
  • Upload date:
  • Size: 31.0 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.20.0.tar.gz
Algorithm Hash digest
SHA256 6a53f8b03f46bc426e28c85872d8a54b73b017d9c2fcd395b14c629dc76fc4d6
MD5 18f731bb961ac718321d1e5b4eb957b6
BLAKE2b-256 70ae1f1660b728d22dc2df095cce5641b55eb20213b1c01fdf30afa3d2f551e8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e966acd33472b561332a574d6c09fa9beeeedc01212d07f16056ef62464e713
MD5 87fe08134ea7a5cdb5261d07aab2d532
BLAKE2b-256 c28989efc40239b878cf3555e8d823048dc771ddade556d4800fbdce19b00efb

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