StreamTree
Declarative, typed composition for Streamlit. Build UI as Python data (@component functions return element trees); the renderer maps them to st.* on each rerun. No separate frontend build.
Documentation (primary): streamtree.readthedocs.io — getting started, recipes, full example source, guides, API reference, and changelog.
At a glance
| Without StreamTree | With StreamTree |
|---|---|
| Long imperative scripts | @component + layouts/widgets as a tree |
Ad hoc session_state keys |
state() scoped to the render path |
| Hard to test structure | streamtree.testing.render_to_tree() and summarize_tree_kinds() |
Includes: layouts (Page, VStack, Form, Routes, …), optional [tables] / [charts] / [ui] / [auth], streamtree.asyncio task helpers, multipage discovery in streamtree.helpers.pages, optional [cli] (streamtree run, doctor, init, tree, …). Details, version notes, and extras matrix live in the docs.
Requirements
Python 3.10+, Streamlit ≥ 1.33, Pydantic v2 (see pyproject.toml).
Install
pip install streamtree
pip install "streamtree[cli]" # Typer + streamtree run / doctor / init / tree
# Optional: [tables] [charts] [ui] [auth] — see Dependency strategy on RTD
From a clone (contributors):
git clone https://github.com/streamtree-dev/streamtree.git
cd streamtree
uv sync --extra dev
Quick start
from streamtree import component, render
from streamtree.elements import Button, Card, Page, Text
from streamtree.state import state
@component
def Counter():
count = state(0)
return Card(
Text(f"Count: {count()}"),
Button("Increment", on_click=lambda: count.increment(1)),
Button("Reset", on_click=lambda: count.set(0)),
)
if __name__ == "__main__":
render(Page(Counter()))
streamlit run examples/counter.py
# with [cli]: streamtree run examples/counter.py
More patterns (interop with raw st.*, App / theme, async, routing, multipage, CRUD) are in the recipes and examples sections on Read the Docs.
Documentation map
| Start here | Read the Docs |
|---|---|
| Install & mental model | Getting started |
| How-to cookbook | Recipes |
Every examples/*.py inlined |
Examples (full source) |
Testing & AppTest |
Testing & debugging |
| Plan, roadmap, deps, performance, phases | Guides (use the site nav: Design & roadmap / Operations) |
| Release history | Changelog |
Design files remain in docs/ in the repo; the site above is the supported reading path for stable releases.
Contributing
uv sync --extra dev
uv run ruff format --check .
uv run ruff check src tests
uv run ty check src
uv run pytest
uv run python -m mkdocs build --strict
uv build
Same checks with pip: pip install -e ".[dev]", then the same ruff, ty, pytest, mkdocs build --strict, and uv build (or python -m build). Coverage is enforced at 100% on src/streamtree (see pyproject.toml). GitHub Actions live under .github/workflows/ (ci.yml, release.yml, and reusable-*.yml); you can re-run CI manually via Actions → CI → Run workflow.
Releases
Before tagging v*.*.*: align pyproject.toml version, CHANGELOG.md, and package metadata (see tests/test_package_meta.py). CI and the release workflow run lint, typecheck, tests, MkDocs, and uv build; publishing needs a valid PyPI token or trusted publishing setup (details in workflow comments and PyPI docs).
Limits (Streamlit)
No stable cross-rerun APIs for arbitrary widget focus or DOM control. Prefer session_state, query params (streamtree.routing, …), st.rerun, and key= discipline. Portal / PortalMount move subtrees within a script; they do not replace Streamlit’s execution model. See Portals & prefetch on RTD.
License
MIT — LICENSE.
Metadata
Release files for streamtree 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| streamtree-0.11.0.tar.gz | 154.6 kB | Without provenance | Details for streamtree-0.11.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| streamtree-0.11.0-py3-none-any.whl | Python 3 | none | any | Details for streamtree-0.11.0-py3-none-any.whl |
Total release size: 219.1 kB
Release files / streamtree-0.11.0.tar.gz
| Download URL | streamtree-0.11.0.tar.gz |
|---|---|
| Size | 154.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
89bb94bc8a831093c4f53227eeb753b8197e88ac55b99cc00e160779799aa650
|
|
BLAKE2b-256 checksum How to use checksums |
c2290f8bbff0e1afd13ca74710da8bd575efbbcd30a2258f3f592e4820521f28
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / streamtree-0.11.0-py3-none-any.whl
| Download URL | streamtree-0.11.0-py3-none-any.whl |
|---|---|
| Size | 64.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dad8e80b0ffa02ba866c441682f1f1e5c365f3a8462b678b39e3a942cbb5e53a
|
|
BLAKE2b-256 checksum How to use checksums |
3dc6f440dab5b3f0271611c4e02b6824f2fd8929c568d7dc69bb60d4fd361f8d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Security for streamtree 0.11.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.