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.24.0.tar.gz (33.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.24.0-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.24.0.tar.gz
  • Upload date:
  • Size: 33.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.24.0.tar.gz
Algorithm Hash digest
SHA256 43f42e202a25cfc814c1c79b5e9ff23fff7306336ec3ae3901bd9b3aedc3c983
MD5 6760c42d432f780283ee797fb72dce5e
BLAKE2b-256 765829470e1ab422151a4d3e00d67de60ee5bc22d7fbd7222485962f37c445f0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 141737bac64c3fbb4d927f66d2e348a84de65147d60535352e12e59415534428
MD5 0b84fb80ca1f825a0b1c8c35facb63f1
BLAKE2b-256 636a1a18a1ba674b5b010ee3728facac2f2b46cfd48e64268d9569651739f1d8

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