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.13.0.tar.gz (25.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.13.0-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.13.0.tar.gz
  • Upload date:
  • Size: 25.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.13.0.tar.gz
Algorithm Hash digest
SHA256 f72a5737b630c04b525d9b34dd2c3549bec6c968e8dcf527698551953e86a0d9
MD5 5988f0b770fe75d03c92d84ef6bd9eed
BLAKE2b-256 309816118bef07b949b6ef30cca44a77f2045c372cdf5f8b590f507658f36eb2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42adcc0d1a651000ff122ac97058ce808839aaeaf9fe70bfd894dbb468ba759f
MD5 2f0a2810880b01c89139f53bc5b99ec3
BLAKE2b-256 bedaa53e0c221016063084b181b93bc1bc8f883658f358b25b86fc1b3213955b

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