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. Each token belongs to one board, so the server resolves the target board from the token — you pass nothing but the bearer. (Set streamboard_id= only to address a board explicitly.) 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.3.0.tar.gz (18.5 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.3.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for streamboard-0.3.0.tar.gz
Algorithm Hash digest
SHA256 08a7fe4577bff7df3f6a193293f5feccfbc6ac50b4d75130f0c0a3e7970a0ae1
MD5 aa97539771eb7cebd3bc6cb47cc4e09a
BLAKE2b-256 5229197ca70e5ec9544a2d1187136828944697ec1917817f6986eec62be0d23e

See more details on using hashes here.

Provenance

The following attestation bundles were made for streamboard-0.3.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: streamboard-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.1 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 035ea8dd3ccbfef8fa655f8fcbf1de0655e033e3f066220c168ee70b51680d65
MD5 f8eb641f8eea24d6fbedde77dfb2ca7c
BLAKE2b-256 dd272bc0eadea99aaac45aad48a083dc8a3fcc23767f381acd89df99ebc82736

See more details on using hashes here.

Provenance

The following attestation bundles were made for streamboard-0.3.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