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.25.0.tar.gz (38.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.25.0-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.25.0.tar.gz
  • Upload date:
  • Size: 38.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.25.0.tar.gz
Algorithm Hash digest
SHA256 9a5c8c6e8f816acb8a5d5c8d825a2379decd1bd874a0f77ea3089e8c511257c7
MD5 bfbab67abb830b0aa04262604bdaafa9
BLAKE2b-256 b115c17ec141f39dbe294f4245f7698174b396adbc3ed721abea4ab3fc229786

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.25.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6c33e42c1c8e7d07719a344d4cf38051cb0848c8d4e1ad58702ce92b3d32ee4
MD5 e9cacb78518bde885e5e270d54783779
BLAKE2b-256 ee6a8800d76d320f53d7d5ac8f68c4a9e808cbe5b60a1e046768db40fbea19d8

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