Komus Tasks SDK (Python)

Python SDK for building, testing, and deploying tasks with the Komus Tasks.

Installation

First public PyPI release: 1.0.0 (ko-tasks CLI and bundled agent skills).

pip install ko-tasks-sdk

Quick Start

1. Create a new task

ko-tasks init my-task --runtime python
cd my-task

2. Edit task.py

async def run(context):
    context.report_progress(0.0, "Starting...")

    inputs = context.get_inputs()
    # ... your logic ...

    context.report_progress(1.0, "Done")
    return [{"kind": "text", "text": "Result"}]

3. Run locally

ko-tasks run

4. Deploy

ko-tasks deploy --server https://tasks.example.com --admin-key YOUR_ADMIN_KEY

CLI Commands

TaskContext API

The context object passed to your task function provides:

Inputs & Outputs

• context.get_inputs() — Returns list of input artifacts
• Return a list of output artifacts from your function

Progress Reporting

• context.report_progress(fraction, message) — Report progress (0.0 to 1.0)

Cooperative Control

• context.check_pause() — Blocks if task is paused, raises if cancelled
• context.is_paused() — Returns True if pause requested
• context.is_cancelled() — Returns True if cancellation requested

Artifacts

• context.store_artifact(data, filename, media_type) — Store output artifact
• context.get_artifact(artifact_id) — Retrieve an artifact

Configuration

• context.get_config(key) — Get a configuration/credential value

Task Definition (task.yaml)

name: my-task
version: 1.0.0
description: "What the task does"
entry_point: task:run
runtime: python                   # python | node

input_schemas:
  - ref: input_data
    kind: text
    required: true
    description: "Input description"

output_schemas:
  - kind: file
    media_type: application/pdf
    description: "Output description"

requirements:
  - name: API_KEY
    required: true
    description: "External API key"

Development

# Clone the monorepo
git clone https://github.com/Komus-ai/ko-tasks-platform.git
cd ko-tasks-platform

# Install in development mode
uv sync

# Run SDK tests
uv run --package ko-tasks-sdk pytest packages/sdk-python/tests/ -v

License

MIT