kwebui 0.11.1__tar.gz

kwebui-0.11.1/.gitignore

@@ -0,0 +1,42 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Tooling caches
+.mypy_cache/
+.ruff_cache/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+
+# Local env / secrets
+.env
+
+../*.jpg
+
+graphify-out
+decisions.md
+milestones.md
+
+docs/class-diagram.md
+#docs/architecture.md
+
+tests/
+
+Readme

kwebui-0.11.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the
+      purposes of this License, Derivative Works shall not include works
+      that remain separable from, or merely link (or bind by name) to the
+      interfaces of, the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Kaptura GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kwebui-0.11.1/PKG-INFO

@@ -0,0 +1,311 @@
+Metadata-Version: 2.4
+Name: kwebui
+Version: 0.11.1
+Summary: Build web UIs in pure Python. A clean, plugin-oriented alternative to Streamlit.
+Author: Ahmad Karambakhsh
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Kaptura-GmbH/kwebui
+Project-URL: Repository, https://github.com/Kaptura-GmbH/kwebui
+Project-URL: Issues, https://github.com/Kaptura-GmbH/kwebui/issues
+Project-URL: Documentation, https://github.com/Kaptura-GmbH/kwebui/blob/master/docs/user-guide.md
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn[standard]>=0.29
+Requires-Dist: jinja2>=3.1
+Requires-Dist: websockets>=12.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Provides-Extra: imagestream
+Requires-Dist: opencv-python-headless>=4.9; extra == "imagestream"
+Requires-Dist: numpy>=1.26; extra == "imagestream"
+Provides-Extra: file-uploader
+Requires-Dist: python-multipart>=0.0.9; extra == "file-uploader"
+Dynamic: license-file
+
+# kwebui
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/)
+[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](#contributing)
+
+**Build web UIs in pure Python — no HTML, CSS, or JavaScript required.**
+
+kwebui is a clean, plugin-oriented alternative to Streamlit: every widget is a
+self-contained plugin, the core framework knows nothing about individual
+widgets, and the whole thing is small enough to read in an afternoon (see
+[`docs/architecture.md`](docs/architecture.md)). A **retained tree** of
+widgets lives server-side; mutating one pushes a single, minimal JSON patch
+over a WebSocket to every connected browser — no full-page reruns, no
+diffing a virtual DOM on every keystroke.
+
+```python
+from kwebui import KApp
+
+class Demo(KApp):
+    def build(self):
+        self.text("Hello World", size=28)
+        self.button("Click Me", on_click=lambda: print("Clicked"))
+
+Demo(title="Demo").run()
+```
+
+![The full showcase app, every widget on one page](docs/images/showcase-overview.png)
+
+## Table of contents
+
+- [Why kwebui](#why-kwebui)
+- [Installation](#installation)
+- [Quickstart](#quickstart)
+- [User guide](#user-guide)
+- [Widgets](#widgets)
+- [Themes](#themes)
+- [Packaging / installing elsewhere](#packaging--installing-elsewhere)
+- [Project layout](#project-layout)
+- [Session model — please read before production use](#session-model)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Why kwebui
+
+- **Pure Python.** No HTML/CSS/JS to write, no separate frontend build step,
+  no Node.js/npm involved anywhere — `pip install -e .` is enough.
+- **Plugin-oriented core.** Every widget (`text`, `button`, `table`,
+  `container`, ...) is a self-contained plugin under `kwebui/widgets/`,
+  auto-discovered at startup. Delete every file under `widgets/` and `KApp`
+  still imports and runs — the core genuinely has no special knowledge of
+  any individual widget type.
+- **Retained tree, not rerun-the-script.** Widgets are live Python objects
+  you mutate directly (`widget.set_text(...)`, `widget.update(...)`) — not
+  something you recreate on every interaction. Each mutation ships exactly
+  one minimal patch to connected browsers.
+- **Small enough to actually read.** The core (`app.py`, `widget.py`,
+  `plugin.py`, `renderer.py`, `registry.py`) is a few hundred lines total.
+  See [`docs/architecture.md`](docs/architecture.md).
+- **No CDN, no build tools.** The frontend is Vue 3, vendored as a single
+  `vue.global.js` file and loaded directly — components are plain JS
+  objects with template strings, not `.vue` Single File Components.
+
+## Installation
+
+Requires Python 3.12+.
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate        # Windows: .venv\Scripts\activate
+pip install -e .                 # add [dev] for tests, [imagestream] for OpenCV demos, [file_uploader] for uploads
+```
+
+Or straight from GitHub, no local clone needed:
+
+```bash
+pip install "git+https://github.com/Kaptura-GmbH/kwebui.git"
+```
+
+See [`docs/user-guide.md`](docs/user-guide.md#1-install-kwebui-as-a-package)
+for every install path (editable, from git, or as a built wheel).
+
+## Quickstart
+
+```bash
+python examples/demo.py          # the snippet above
+python examples/showcase.py      # every built-in widget on one page
+python examples/workflow.py      # topbar + workflow_tracker driving which page a container() shows
+python examples/custom_theme.py  # a theme CSS file shipped from your own project, not the kwebui package
+python examples/mjpeg_demo.py    # live MJPEG stream + snapshot capture (needs [imagestream])
+python examples/daheng_demo.py   # Daheng camera picker + live config (needs gxipy, see its docstring)
+```
+
+Open the printed URL (default `http://127.0.0.1:8701`, or the next free
+port after it if 8701 is already taken) in a browser.
+
+## User guide
+
+See [`docs/user-guide.md`](docs/user-guide.md) for the full walkthrough
+with a real screenshot for every widget. The short version:
+
+1. Subclass `KApp` and override `build()` to construct the page **once**
+   by calling widget methods on `self` (`self.text(...)`, `self.button(...)`,
+   ...) — `build()` runs automatically when you instantiate the class.
+   Then call `MyApp(title="...").run()`.
+2. Every widget method returns a live widget object. Store it on `self`
+   to change it later — from a callback, a background thread, or
+   anywhere else — and the browser updates automatically, without a
+   full page reload:
+
+   ```python
+   class Demo(KApp):
+       def build(self):
+           self.greeting = self.text("Hello")
+           self.button("Again", on_click=self.say_again)
+
+       def say_again(self):
+           self.greeting.set_text("Hello again")   # pushes a minimal patch to every browser
+   ```
+3. Callbacks (`on_click`, `on_change`, ...) are plain Python functions
+   that run on the server, each on its own worker thread — the browser
+   only ever sends events, so a blocking callback never freezes the UI
+   for other connected browsers.
+4. Advanced: inside a callback, `self.session` gives you the connection
+   that triggered it (`self.session.state` is a free scratchpad dict).
+   Most apps never need this.
+
+## Widgets
+
+For the full, illustrated version of this table — a real screenshot for
+every widget, plus the install-and-run walkthrough in more depth — see
+[`docs/user-guide.md`](docs/user-guide.md).
+
+| Widget | Example (inside `build()`, called on `self`) |
+|---|---|
+| Text | `self.text("Hi", size=24, color="red", bold=True, italic=False, align="left")` |
+| Button | `self.button("Save", on_click=save, enabled=True, shortkey="ctrl+k", color="red", text_color="white")` — `shortkey` binds a keyboard combo (`"k"`, `"shift+k"`, `"ctrl+k"`, `"shift+ctrl+k"`) that calls `on_click`, but only while the button is visible and enabled; `color`/`text_color` accept any CSS color and default to the theme's `--sg-button-bg`/`--sg-button-text-color` variables (an explicit value overrides just that button) |
+| Checkbox | `self.checkbox("Enable feature", checked=False, on_change=lambda v: ...)` |
+| TextEdit | `self.textedit("Name", placeholder="Jane", multiline=False, password=False, on_change=lambda v: ..., on_enter=lambda v: ...)` |
+| Slider | `self.slider("Volume", min_value=0, max_value=100, value=50, on_change=lambda v: ...)` |
+| ListBox | `self.listbox(["A", "B", "C"], on_select=lambda item: ...)` |
+| ProgressBar | `self.progressbar(50)` / `self.progressbar(0, indeterminate=True)` |
+| Spinner | `with self.spinner("Working...", show_time=True): do_slow_thing()` |
+| Image | `self.image("cat.jpg", width=150)` / `self.image("cat.jpg", stretch=True)` — `width` (-1/0 = natural size, default) resizes the viewer; `stretch=True` fills the parent container's width instead. Local paths and URLs both work |
+| ImageStream | `self.imagestream(frame_provider=capture_jpeg, fps=15)` — live MJPEG feed (webcam/OpenCV); or call `stream.push_frame(jpeg_bytes)` yourself. Same `width`/`stretch` as Image. `stream.latest_frame()` returns the most recent JPEG bytes (see `examples/mjpeg_demo.py` for a snapshot-capture button) |
+| FileUploader | `self.file_uploader("Upload a file", accept=".csv", on_upload=lambda filename, data: ...)` — needs the `[file_uploader]` extra installed; without it, uploads return a clear error instead of failing |
+| Html | `self.html("<strong>Raw HTML</strong>")` — trusts the string, don't pass unsanitized user input |
+| Json | `self.json({"status": "ok", "items": [1, 2, 3]})` — pretty-printed, read-only |
+| Table | `self.table([{"name": "Alice", "age": 30}], width=-1, stretch=False, border=True, hide_header=False)` — read-only dataframe-style grid; also accepts a dict of columns, a list of lists + `columns=...`, or a real `pandas.DataFrame` (detected by shape, no pandas dependency added) |
+| Empty | `slot = self.empty(); slot.text("Loading..."); slot.progressbar(80)` — a placeholder whose content can be swapped in place |
+| Container | `page = self.container(width=300, height=-1, stretch=False, border=True, border_roundness=True, caption="Settings", direction="vertical", wrap=False, horizontal_alignment=None, vertical_alignment=None, shortkey=None, on_keypress=None, vertical_padding=None, horizontal_padding=None); page.text("Hi"); page.button("Go"); ...; page.clear()` — like `Empty`, but holds a whole group of widgets instead of one; `.clear()` wipes it before rebuilding with different content. `direction="horizontal"` lines children up side by side (each at its own natural size) instead of stacked — unlike `columns(n)`'s fixed-width slots — and `wrap=True` lets them flow onto further lines once a row no longer fits, e.g. a row of `Badge`s. `horizontal_alignment`/`vertical_alignment` (`"left"/"center"/"right"` and `"top"/"center"/"bottom"`) position children within a fixed `width`/`height`, e.g. a "panel" with a centered button — their meaning stays tied to the horizontal/vertical axis regardless of `direction`. `shortkey` works like Button's, but calls `on_keypress` (there's no `on_click` to reuse) and only fires while the container is visible. `vertical_padding`/`horizontal_padding` (px) default to the theme's `--sg-container-padding-vertical`/`--sg-container-padding-horizontal` variables (`10px` each); an explicit value (including `0`) overrides just that container |
+| Success / Info / Warning / Error | `self.success("Saved!")`, `self.info(...)`, `self.warning(...)`, `self.error(...)` — colored status banners |
+| Badge | `self.badge("New")` / `self.badge("Active", icon="✅", color="success")` — a small pill-shaped status/tag label; `color` is `success`/`info`/`warning`/`error` (same colors as the banners above) or `None` for neutral |
+| Toast | `self.toast("Saved!", level="success")` — a transient corner notification |
+| Columns | `left, right = self.columns(2)` — side-by-side containers, each accepting the same widget calls as `self`; or `narrow, wide = self.columns([0.3, 0.7])` for relative widths (weights must be positive and sum to 1) |
+| Sidebar | `nav = self.sidebar()` — a persistent panel pinned to the left edge, collapsible by default |
+| Popup | `self.popup("Discard changes?", kind="yesno", on_return=lambda answer: ...)` — a modal dialog; `kind` is `ok`, `okcancel`, `yesno`, or `yesnocancel` |
+| WorkflowTracker | `self.workflow_tracker(tasks, orientation="horizontal", on_select=lambda task_id: ...)` — a step tracker; each task is `{"id", "title", "status", "detail"}` |
+| Topbar | `bar = self.topbar(); bar.workflow_tracker(tasks)` — a full-width panel pinned to the top of the page, sticky by default |
+
+Every widget returned by `self.<widget>(...)` has an `.update(**props)`
+method plus typed setters (e.g. `text.set_text(...)`, `checkbox.set_checked(...)`).
+Every widget also has, regardless of type:
+
+```python
+self.name.highlight()          # outline in the theme's default color (red)
+self.name.highlight("#16a34a") # or a specific color, for this widget only
+self.name.unhighlight()
+
+self.name.focus()              # send keyboard focus to it
+
+self.name.hide()                # visually hide it (stays in the tree, keeps its state)
+self.name.show()                # reveal it again
+self.name.remove()              # drop it from the page and server memory for good
+```
+
+## Themes
+
+```python
+self.set_theme("dark")   # or "light" (default)
+```
+
+Themes are plain CSS files. The bundled ones live in `kwebui/themes/` —
+add a third by dropping a `themes/<name>.css` file there defining the
+same `--sg-*` custom properties as `light.css`/`dark.css`. `--sg-highlight`
+is the default color `.highlight()` uses when called without an explicit
+color.
+
+`set_theme()` also accepts a path to a CSS file anywhere in your own
+project, not bundled with kwebui at all — `self.set_theme("assets/brand.css")`.
+Its name becomes that file's own stem (`brand.css` → `"brand"`); pass
+that name again later to switch back to it. See
+[`docs/user-guide.md`](docs/user-guide.md#8-themes) for the full
+behavior (when it takes effect, live reload from disk, ...) and
+`examples/custom_theme.py` for a runnable example.
+
+Some `--sg-*` variables are structural defaults rather than
+theme-specific colors — `--sg-button-bg`/`--sg-button-text-color`
+(`button`'s `color`/`text_color` defaults) and
+`--sg-container-padding-vertical`/`--sg-container-padding-horizontal`
+(`container`'s padding defaults, `10px` each) live once in `base.css`'s
+`:root` and apply across every theme. Override them in a custom
+stylesheet to change the default everywhere at once, or pass the
+matching widget parameter to override just one instance.
+
+## Packaging / installing elsewhere
+
+This is a standard `pyproject.toml` package, so any of these work:
+
+```bash
+# Editable install for local development (what the steps above do)
+pip install -e .
+
+# Build a distributable wheel + sdist
+pip install build
+python -m build                                  # writes dist/kwebui-<version>-py3-none-any.whl
+pip install dist/kwebui-<version>-py3-none-any.whl   # on any machine with that wheel
+
+# Install straight from this repository (no PyPI needed)
+pip install "git+https://github.com/Kaptura-GmbH/kwebui.git"
+```
+
+To embed kwebui in another app: `pip install` it into that app's own
+venv the same way, then `from kwebui import KApp` as usual — there is
+no separate "export" step, the package *is* the deliverable.
+
+## Project layout
+
+See [`docs/architecture.md`](docs/architecture.md) for the plugin system,
+rendering pipeline, event flow, and session model, and
+[`docs/class-diagram.md`](docs/class-diagram.md) for a Mermaid class
+diagram of the core framework and every built-in widget plugin.
+
+The frontend (`kwebui/frontend/static/`) is Vue 3, loaded as a single
+`vue.global.js` file (vendored under `static/js/vendor/`, no CDN) rather
+than Single File Components — this keeps `pip install -e .` free of any
+Node.js/npm involvement, at the cost of writing components as plain JS
+objects with template strings instead of `.vue` files. Each widget type
+is still its own file under `frontend/static/js/widgets/`, auto-discovered
+and injected as a `<script>` tag the same way the Python side auto-discovers
+plugins.
+
+## Session model
+
+> [!IMPORTANT]
+> All browsers connected to a running app share the *same* live widget
+> tree — this is a broadcast/dashboard model (like a kiosk or control
+> panel), **not** Streamlit's per-tab isolated state. Great for "one
+> screen, several viewers" — control panels, dashboards, kiosks; not
+> meant for multi-tenant apps where each visitor should see their own
+> private data.
+
+This is a deliberate simplification, not an oversight: true per-session
+isolation would mean cloning the widget tree per connection and
+re-binding every callback closure to the clone, which is a lot of
+machinery for a library meant to be readable in an afternoon. `Session`
+is still its own class internally, so per-session isolation could be
+added later without an API break — see
+[`docs/architecture.md`](docs/architecture.md#5-sessions) for the
+reasoning in full.
+
+## Contributing
+
+Issues and pull requests are welcome. Before opening a PR:
+
+1. For anything touching rendering, layout, or an interactive round-trip
+   (click → server → browser), verify it in a real browser — several
+   real bugs in this codebase's history were invisible in a code read and
+   obvious in a screenshot.
+2. Keep changes scoped: a bug fix doesn't need surrounding refactors, and
+   a new widget should follow the existing plugin pattern (see
+   [`docs/architecture.md`](docs/architecture.md) and any existing
+   `kwebui/widgets/*.py` file as a template).
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).