Pre-release
This release is a pre-release and may not be stable for production use.
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("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
1 maintainer
Metadata
1 maintainer
Release files for iii-sdk 0.24.4a2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| iii_sdk-0.24.4a2.tar.gz | 207.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| iii_sdk-0.24.4a2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 251.2 kB
Release files / iii_sdk-0.24.4a2.tar.gz
| Download URL | iii_sdk-0.24.4a2.tar.gz |
|---|---|
| Size | 207.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a8589b19660e825c6c68a6161719673ea668b21808c1d631ce704b33fc56bf6c
|
|
BLAKE2b-256 checksum How to use checksums |
798110cbf1c5cafe017bbd48ae312c33dc6943485d016b2980bfd66d4fbd1f04
|
| 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.4a2-py3-none-any.whl
| Download URL | iii_sdk-0.24.4a2-py3-none-any.whl |
|---|---|
| Size | 43.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2293be88c6bef2d7a68cdb75952d87ffc647f56f2874e0f631c691c63d91d06f
|
|
BLAKE2b-256 checksum How to use checksums |
6b36afb8dbc8b7bc103dc7c30ee5aec510d8533f1b48a8b3b4bed2ef599964cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
