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
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.23.0rc9.tar.gz
(201.9 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.23.0rc9.tar.gz.
File metadata
- Download URL: iii_sdk-0.23.0rc9.tar.gz
- Upload date:
- Size: 201.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
24c93a444f81f71dd51516e7eb7449e33e781313d595976a0f6d185fb7275a88
|
|
| MD5 |
25e75e259dea5492d09850ca2af9adcf
|
|
| BLAKE2b-256 |
ecccc9bf29e32f0ab3274861563ffd212a519a6526b850c055de8659c8c6c2a2
|
File details
Details for the file iii_sdk-0.23.0rc9-py3-none-any.whl.
File metadata
- Download URL: iii_sdk-0.23.0rc9-py3-none-any.whl
- Upload date:
- Size: 42.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54001bb96d1e26df5cff4889b5cda666acee23cdccd9e995ac0ea0f4a414bf15
|
|
| MD5 |
e7c26cfd849a1b9b1f1ac90bb8b11b63
|
|
| BLAKE2b-256 |
f1a5bd7cee854b8e4f8cebe26fd222f3d4c5e284cab3e1b7435bf4ae8b3240af
|
