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.0.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.0-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.23.0.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.0.tar.gz
Algorithm Hash digest
SHA256 c5d22c2fc799eec3120ef85e0e5a8c88085900d27ebcef28daaa4343fb3a7df7
MD5 68524629aab84bb07f03a4557ac668aa
BLAKE2b-256 a105f617d934130bb8b7d8bcb33802209980a7361348ba710383e4e03a94b9cc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.23.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3c4cf08d29d4cb272231dfb664df1ed1bc8457fd7c4d1d40567ce50358c4a28
MD5 4bf7af8fbae105ae3d1c45c3f2f89cdc
BLAKE2b-256 9a3a6ef8a0817137ac597ecf9cda47ca669861b15ba8009969ecf5817ab40bcf

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