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.23.1.tar.gz (32.9 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.23.1-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.23.1.tar.gz
  • Upload date:
  • Size: 32.9 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.23.1.tar.gz
Algorithm Hash digest
SHA256 3c30f3b5b36ec33957025fa2a28db16126e0630a292e1a4abaddd672a6d2e40a
MD5 eb6ba43e52420c92b7826d5aac352859
BLAKE2b-256 d33486197cccac7ec1e2984898f10b57fff3a471f6c68fdd1ccba2ff191ec383

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.23.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ba223c9db981202e47b880a287d72155ea5f02eae6097adfea9fe252dbba036b
MD5 a32fb0f04df0c95a31c6b577cb48a236
BLAKE2b-256 707f7b4f94be9af04de5e65ae4364146e3d48e10e6d6a8d41da471de0645d7fe

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