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.18.1.tar.gz (29.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.18.1-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_workflows-0.18.1.tar.gz
  • Upload date:
  • Size: 29.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.18.1.tar.gz
Algorithm Hash digest
SHA256 ea3f9f34d8c5499eb76c2424b6c7e3a5defe34fc7970ee2fd9d54d8d466c89be
MD5 51a3d892e0d336d2ccabc3593112bf1a
BLAKE2b-256 814ecf455c8dc3481dd77cb81d787473dc588a1bb94575f6f3f21a3e120cad09

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kestrel_workflows-0.18.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f12d7eea8e65e93fe14f8e99993d59fe11fc07ac80727bc4513a2272fd7d1511
MD5 8c98d63dac6ad3710928f709bb569561
BLAKE2b-256 d1b417fa418620f9eb57d90f10016256e612f5a41e726496bd8b5f213735235a

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