Skip to main content

III SDK for Python

Project description

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({"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


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.dev2.tar.gz (182.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iii_sdk-0.11.2.dev2-py3-none-any.whl (46.8 kB view details)

Uploaded Python 3

File details

Details for the file iii_sdk-0.11.2.dev2.tar.gz.

File metadata

  • Download URL: iii_sdk-0.11.2.dev2.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

Hashes for iii_sdk-0.11.2.dev2.tar.gz
Algorithm Hash digest
SHA256 06ca7cc6247184f4821197be06c3e07cf4e75e78a24d775c2d3cd8e98b9c6c80
MD5 22ea87013f71fd9340def1b4c5ba1cea
BLAKE2b-256 59873d8a76fdd7f31c4cec22035bec2aad7e14d4de7669a893dde716c97ce5f0

See more details on using hashes here.

File details

Details for the file iii_sdk-0.11.2.dev2-py3-none-any.whl.

File metadata

  • Download URL: iii_sdk-0.11.2.dev2-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

Hashes for iii_sdk-0.11.2.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 801642b87820f459b598e5354991ad3f95f23210da808fb913e89daf9107aed1
MD5 5d5403e46598f6ea5ea9b58ee96599ea
BLAKE2b-256 5d03668ea9d2f08ad5470008c11113a3cacf0a4437c7f2900eb7bbef0c8b715d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page