Skip to main content

iii-sdk

Python SDK for the iii engine.

PyPI Python License

Install

pip install iii-sdk

Hello World

from iii import register_worker

iii = register_worker("ws://localhost:49134")

def greet(data):
    return {"message": f"Hello, {data['name']}!"}

iii.register_function("hello::greet", greet)

iii.register_trigger({
    "type": "http",
    "function_id": "hello::greet",
    "config": {"api_path": "/greet", "http_method": "POST"},
})

iii.connect()

result = iii.trigger({"function_id": "hello::greet", "payload": {"name": "world"}})
print(result)  # {"message": "Hello, world!"}

API

Operation Signature Description
Initialize register_worker(url, options?) Create an SDK instance and auto-connect
Register function iii.register_function(id, handler) Register a function that can be invoked by name
Register trigger iii.register_trigger({"type": ..., "function_id": ..., "config": ...}) Bind a trigger (HTTP, cron, queue, etc.) to a function
Invoke (await result) iii.trigger({"function_id": id, "payload": data}) Invoke a function and wait for the result
Invoke (fire-and-forget) iii.trigger({"function_id": id, ..., "action": TriggerAction.Void()}) Fire-and-forget
Invoke (enqueue) iii.trigger({"function_id": id, ..., "action": TriggerAction.Enqueue(queue="name")}) Route invocation through a named queue
Shutdown iii.shutdown() Disconnect and stop background thread

register_worker() creates the SDK instance and auto-connects to the engine.

Registering Functions

def create_order(data):
    return {"status_code": 201, "body": {"id": "123", "item": data["body"]["item"]}}

iii.register_function("orders::create", create_order)

Registering Triggers

iii.register_trigger({
    "type": "http",
    "function_id": "orders::create",
    "config": {"api_path": "/orders", "http_method": "POST"},
})

Invoking Functions

result = iii.trigger({"function_id": "orders::create", "payload": {"body": {"item": "widget"}}})

Development

Install in development mode

pip install -e .

Type checking

mypy src

Linting

ruff check src

Resources

Release files for iii-sdk 0.24.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iii-sdk 0.24.1
File Size Uploaded
iii_sdk-0.24.1.tar.gz 202.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for iii-sdk 0.24.1
File Interpreter ABI Platform
iii_sdk-0.24.1-py3-none-any.whl Python 3 none any Details

Total release size: 245.0 kB

Release files / iii_sdk-0.24.1.tar.gz

Download URL iii_sdk-0.24.1.tar.gz
Size 202.4 kB
Tags Source
SHA-256 checksum
How to use checksums
13eddb4a9fca5748a9564b667c0927a9b4bccb20102441193412e22c45ff64ec
BLAKE2b-256 checksum
How to use checksums
551a4850294f8fa19e8773d2d3d0f3e326f791775e3b19af801889e2e62dd8e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / iii_sdk-0.24.1-py3-none-any.whl

Download URL iii_sdk-0.24.1-py3-none-any.whl
Size 42.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
854c798affad334c72cd39252060b0bc53dfd0530789ac1e95184db6d787b0c9
BLAKE2b-256 checksum
How to use checksums
a8efb38d5a6f92cd4d7addf9f3b98eeb54ef8df9e75e6b56ee59362aaa5fdd56
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

0.24.3

2 release files

0.24.2

2 release files

This release

0.24.1 This release

2 release files

0.24.0

2 release files

0.22.0

2 release files

0.21.8

2 release files

0.21.6

2 release files

0.21.5

2 release files

0.20.0

2 release files

0.19.7

2 release files

0.19.6

2 release files

0.19.4

2 release files

0.19.3

2 release files

0.16.1

2 release files

0.16.0

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.5

2 release files

0.11.4

2 release files

0.11.3

2 release files

0.11.2

2 release files

0.11.1

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page