III SDK for Python
Project description
iii-sdk
Python SDK for the iii engine.
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({"id": "greet"}, greet)
iii.register_trigger({
"type": "http",
"function_id": "greet",
"config": {"api_path": "/greet", "http_method": "POST"},
})
iii.connect()
result = iii.trigger({"function_id": "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": 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 |
| 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({"id": "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"}}})
Modules
| Import | What it provides |
|---|---|
iii |
Core SDK (III, types) |
iii.stream |
Stream client for real-time state |
iii.telemetry |
OpenTelemetry integration |
Development
Install in development mode
pip install -e .
Type checking
mypy src
Linting
ruff check src
Resources
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
iii_sdk-0.11.2.dev3.tar.gz
(182.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iii_sdk-0.11.2.dev3.tar.gz.
File metadata
- Download URL: iii_sdk-0.11.2.dev3.tar.gz
- Upload date:
- Size: 182.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b164e41fc147743ca083b32e4c32da2b3e12829b3efa5ebc7d2281345d79c566
|
|
| MD5 |
8e5a1062c540797d10ae8cbcc1a04920
|
|
| BLAKE2b-256 |
809635f7d75a8f2423e124f466b52ab36f3ecfbfe804fdd46f35b92acc1d07e4
|
File details
Details for the file iii_sdk-0.11.2.dev3-py3-none-any.whl.
File metadata
- Download URL: iii_sdk-0.11.2.dev3-py3-none-any.whl
- Upload date:
- Size: 46.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e3b5e15be62f373fd416376e728313413019e0eb9441fad9b916224cfb7ec60e
|
|
| MD5 |
086211f1a6f21034bca50b1ac398d9ee
|
|
| BLAKE2b-256 |
d6ca2f6d0eaaf31874d4d43d547d718422b28a6a2e92d5f426c16bdf5ec12529
|