dashwire 0.1.0

/ Python SDK

---

Connect a Python project to a Dashwire control plane.

Register capabilities, synchronize state, receive commands, and publish logs from Python.

Installation · Usage · Capabilities · Repository

Overview

dashwire is the Python counterpart of @dashwire/sdk. It builds the same dashboard structure from the capabilities you register, registers the project over HTTP (POST /api/projects/:id/register), and keeps a realtime Socket.IO connection to the server's /sdk namespace for state updates, commands, actions, and logs.

The connection runs on background threads, so it works in plain scripts, workers, and web apps alike. Handlers are called from the socket thread.

Installation

Requires Python 3.9 or newer.

pip install "git+https://github.com/meesakveld/dashwire.git#subdirectory=packages/python-sdk"

From a local checkout:

pip install -e packages/python-sdk

Usage

import os
from dashwire import Dashboard

dashboard = Dashboard(
    id="warehouse-worker",
    name="Warehouse Worker",
    server_url=os.environ.get("DASHWIRE_SERVER_URL"),
    token=os.environ.get("DASHWIRE_TOKEN"),
)

with dashboard.section("Runtime") as section:
    section.status("health", label="Health", value="Operational", tone="success")

    maintenance = section.toggle("maintenance", label="Maintenance mode", value=False)

    @maintenance.on_change
    def on_maintenance(enabled: bool) -> None:
        print("Maintenance mode:", enabled)

    terminal = section.terminal("logs", label="Logs")

dashboard.connect()
terminal.log.info("Service started")
dashboard.wait()  # or dashboard.run_forever() instead of connect() + wait()

connect() blocks until the project is registered, retrying with exponential backoff (max. 30s) while the server is unreachable. Once connected, the Socket.IO client reconnects automatically and re-sends the current state after every reconnect.

Dashboard can also be used as a context manager: with Dashboard(...) as dashboard: connects on enter and disconnects on exit.

A complete example lives in examples/basic.py.

Capabilities

Register capabilities inside a section with with dashboard.section(name) as section:. All options are keyword arguments.

Every method returns a handle:

• handle.value – current value
• handle.set_value(value) – update locally and push to the dashboard
• @handle.on_change – register a handler as a decorator (alternative to the keyword argument)
• terminal.log.debug/info/warn/error(message, metadata=None) – publish a log line

Other Dashboard methods: get_structure(), subscribe(listener), emit_log(level, message, source, metadata), is_connected(), disconnect().

Configuration

Tokens are created on the server's /security page. Do not commit production tokens to source control.

Log output uses the standard logging module under the dashwire logger.

Development

cd packages/python-sdk
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest

Repository

This package is maintained in the Dashwire monorepo.

License

Licensed under the ISC License.