rstui 0.2.1

Python SDK for the rstui graphical terminal runtime

rstui

Python child SDK for the rstui graphical terminal runtime.

python3 -m pip install rstui
cargo install rstui

from rstui import Frame, run

def on_event(event, context):
    return "render" if event["type"] == "start" else "continue"

def render(context):
    width = context["geometry"]["pixel_width"]
    height = context["geometry"]["pixel_height"]
    return Frame(width, height, bytes(width * height * 4))

run(on_event, render)

Run the application with:

rstui run -- python3 app.py

stdout is reserved for the framed protocol. Write diagnostics to stderr.

Adaptive Matplotlib dashboard

Install the optional adapter and define only the grid, spans, and panel content:

python3 -m pip install 'rstui[matplotlib]'

from rstui import run
from rstui.matplotlib import Dashboard, Panel

def draw_chart(panel):
    axes = panel.axes()
    axes.plot([0, 1], [0, 1])

def draw_details(panel):
    axes = panel.axes()
    axes.set_axis_off()
    axes.text(0, 1, "Ready", va="top")

def on_event(event, context):
    return "render" if event["type"] in {"start", "resize"} else "continue"

page = Dashboard(
    columns=(2, 1),
    rows=(1,),
    panels=(
        Panel("chart", draw_chart, row=0, column=0, title="Chart"),
        Panel("details", draw_details, row=0, column=1, title="Details"),
    ),
)

run(on_event, page.render)

panel.axes() is already constrained to that panel. Full-screen pixels, terminal cells, resize, borders, titles, and framebuffer placement remain rstui responsibilities. Use Insets only when a chart needs extra panel-local room for tick labels.

Project: https://github.com/maokangkun/Terminal/tree/main/rstui