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.0.dev7.tar.gz (181.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.0.dev7-py3-none-any.whl (46.3 kB view details)

Uploaded Python 3

File details

Details for the file iii_sdk-0.11.0.dev7.tar.gz.

File metadata

  • Download URL: iii_sdk-0.11.0.dev7.tar.gz
  • Upload date:
  • Size: 181.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.0.dev7.tar.gz
Algorithm Hash digest
SHA256 b1ba1450fe6d2d766aeed78121562702ffd6ca29f173ad5dfd9dc573f0596710
MD5 03e1995aeead4829ea9a72cc16db24af
BLAKE2b-256 051ccf698ad92e5f6e513357e26fd5e4b5442ec1d7d02027542d28bf4207f4f2

See more details on using hashes here.

File details

Details for the file iii_sdk-0.11.0.dev7-py3-none-any.whl.

File metadata

  • Download URL: iii_sdk-0.11.0.dev7-py3-none-any.whl
  • Upload date:
  • Size: 46.3 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.0.dev7-py3-none-any.whl
Algorithm Hash digest
SHA256 81a2994124de86417a20080c1a8a8222be4bf797ecc907051f6e9fe614f27a60
MD5 7b0d7b308c4a1dec1943a47edb0da7ee
BLAKE2b-256 32a961bb5dc6945ee6dd388cb4996246d6d613e3924d151c92af2e6f5e1dfc22

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