Skip to main content

Python client for pushing live data to a streamboard (KPIs, charts, tables) without re-asking an LLM.

Project description

streamboard (Python)

Push live data to a streamboard — keep KPI tiles, charts, and tables fresh from a cron, agent, or any process, without re-asking an LLM. Mirrors the TypeScript @streamboard/sdk.

uv add streamboard          # or: pip install streamboard
import os
from streamboard import Streamboard

board = Streamboard(token=os.environ["STREAMBOARD_TOKEN"])

board.push({"kpis": {"mrr": {"value": "$48.2k", "delta": "+4%", "trend": "up"}}})

snap = board.pull()
print(snap.version, snap.updated_at, snap.state)

Auth is a per-streamboard bearer token (sb_d_<id>_<secret>) minted at /app/s/:id/tokens; the SDK derives the board id from it. push() is last-write-wins — send the full envelope the spec expects. 429 / 5xx / network failures retry with jittered backoff honouring Retry-After.

Typed state

Generate TypedDicts for a board's state envelope from its live schema:

streamboard-codegen --token "$STREAMBOARD_TOKEN" -o state_types.py
from state_types import StreamboardState
state: StreamboardState = {"kpis": {"mrr": {"value": "$48.2k"}}}
board.push(state)

Develop

uv sync
uv run ruff check . && uv run ruff format --check .
uv run ty check
uv run pytest

Will move into the public streamboard-sdks monorepo (ts / go / python / cli) — tracked separately; built in-tree here first.

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

streamboard-0.1.0.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

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

streamboard-0.1.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file streamboard-0.1.0.tar.gz.

File metadata

  • Download URL: streamboard-0.1.0.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for streamboard-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ad8979a2482352edc0133079339fa66e6a88850fa645f2e3e60a113a251bd1ad
MD5 d95641823745a205ffc3c2584d576d68
BLAKE2b-256 29fca74a08013a967fa9ebbb5b8b6a8d5af40e90c924c05df06d1f204a7dd3d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for streamboard-0.1.0.tar.gz:

Publisher: release-pypi.yml on usestreamboard/streamboard

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file streamboard-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: streamboard-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for streamboard-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d06af6d9eb0055f3c84119d3786a36cc00270dd7396b062039323ba75c065d3c
MD5 c4ea290ad256a7afc1f3582ca145aceb
BLAKE2b-256 f117fa491215e5500db9614afb891557083d43ad98a7a3c6c21f416d95f1423f

See more details on using hashes here.

Provenance

The following attestation bundles were made for streamboard-0.1.0-py3-none-any.whl:

Publisher: release-pypi.yml on usestreamboard/streamboard

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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