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.12.0.dev1.tar.gz (181.9 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.12.0.dev1-py3-none-any.whl (46.6 kB view details)

Uploaded Python 3

File details

Details for the file iii_sdk-0.12.0.dev1.tar.gz.

File metadata

  • Download URL: iii_sdk-0.12.0.dev1.tar.gz
  • Upload date:
  • Size: 181.9 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.12.0.dev1.tar.gz
Algorithm Hash digest
SHA256 631876514424e86d07522c6294b94653100a7644405d44f09b2e5ba3dd40dde7
MD5 a0fcb02f689589f544d26048d2e7e71e
BLAKE2b-256 bf1976f1954a36b34d3e73643d31518dffbc42b7d11f6666e85bd991379d0f12

See more details on using hashes here.

File details

Details for the file iii_sdk-0.12.0.dev1-py3-none-any.whl.

File metadata

  • Download URL: iii_sdk-0.12.0.dev1-py3-none-any.whl
  • Upload date:
  • Size: 46.6 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.12.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d06815a63a7848d61883dec166b5f6e7e78ff0ef5da1fc4e3cc9c787a22ffa7
MD5 9129cf8005ce7bf9e8c50aac78eb7cc9
BLAKE2b-256 e908db290bebcbeaa049d97e0f9f650286e42ad3933cae17752cb00cb736b867

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