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.1.dev1.tar.gz (182.2 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.1.dev1-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iii_sdk-0.11.1.dev1.tar.gz
  • Upload date:
  • Size: 182.2 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.1.dev1.tar.gz
Algorithm Hash digest
SHA256 3c9d713f1405b5c9e7f176e41280bc34e6252a10bbd7b4db40e1216eef82db86
MD5 3fb6cf9e9af692e21dc72ee5380065d7
BLAKE2b-256 cf464a63a898a6df908c138e699c21e751aa4949736dd9f0abbcc4247794acea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iii_sdk-0.11.1.dev1-py3-none-any.whl
  • Upload date:
  • Size: 46.4 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.1.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 98a283e5086bf9fc5eb0d339eb98ba153b03d709fd4fc9c9c5574c23c0e12a92
MD5 99576d5dff3751a0bb21b09ff277c8d2
BLAKE2b-256 5bcdb09aaf214bb15f5bbd6e3d9be096fcb9335fd3840838717414e6e23c404e

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