panelmark-web 0.1.0__tar.gz

panelmark_web-0.1.0/.claude/settings.local.json

@@ -0,0 +1,49 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git init:*)",
+      "Bash(git remote:*)",
+      "Bash(git branch:*)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python -c \"import panelmark_web; from panelmark_web.keymap import BROWSER_TO_PM; from panelmark_web import renderer, session, protocol; print\\('Phase 1 OK'\\)\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -c \"import panelmark_web; from panelmark_web.keymap import BROWSER_TO_PM; from panelmark_web import renderer, session, protocol; print\\('Phase 1 OK'\\)\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -c \"from panelmark.draw import WriteCmd, FillCmd, CursorCmd, RenderContext; import dataclasses; print\\('WriteCmd:', [f.name for f in dataclasses.fields\\(WriteCmd\\)]\\); print\\('FillCmd:', [f.name for f in dataclasses.fields\\(FillCmd\\)]\\); print\\('CursorCmd:', [f.name for f in dataclasses.fields\\(CursorCmd\\)]\\); print\\('RenderContext:', [f.name for f in dataclasses.fields\\(RenderContext\\)]\\)\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -m pytest tests/test_renderer.py -q 2>&1)",
+      "Bash(pip3 install:*)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_renderer.py -q 2>&1)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -c \"from panelmark.shell import Shell; import inspect; print\\(inspect.signature\\(Shell.__init__\\)\\)\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -c \"\nfrom panelmark.interactions.base import Interaction\nimport inspect\nprint\\(inspect.getsource\\(Interaction.render\\)\\)\n\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_session.py -q 2>&1)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -c \"\nfrom panelmark.shell import Shell\nimport inspect\nprint\\(inspect.getsource\\(Shell.handle_key\\)\\)\n\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_server.py -q 2>&1)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest -q 2>&1)",
+      "Bash(git add:*)",
+      "Bash(git rm:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(git:*)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-html:/home/sirrommit/claude_play/panelmark /home/sirrommit/claude_play/panelmark/.venv/bin/pytest /home/sirrommit/claude_play/panelmark-html -q 2>&1)",
+      "Bash(gh pr:*)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_integration.py -q 2>&1)",
+      "Bash(gh repo:*)",
+      "Bash(pip3 show:*)",
+      "Bash(/home/sirrommit/claude_play/panelmark/.venv/bin/pip show:*)",
+      "Bash(/home/sirrommit/claude_play/panelmark/.venv/bin/pip install:*)",
+      "Bash(/home/sirrommit/claude_play/panelmark/.venv/bin/python3 -c \"\nimport simple_websocket, inspect\nsrc = inspect.getsource\\(simple_websocket.Server.receive\\)\nprint\\(src\\)\n\")",
+      "Bash(ls:*)",
+      "Bash(/home/sirrommit/claude_play/panelmark/.venv/bin/python3 -c \"\nfrom starlette.websockets import WebSocketDisconnect\nprint\\('WebSocketDisconnect:', WebSocketDisconnect\\)\nimport inspect\nprint\\(inspect.getsource\\(WebSocketDisconnect\\)\\)\n\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_page.py -q 2>&1)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html pytest -q)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_interactions.py -v)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_widgets.py -v)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_portable_integration.py -v)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_interactions.py -v --tb=short)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html /home/sirrommit/claude_play/panelmark/.venv/bin/pytest tests/test_portable_integration.py -v --tb=short)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python -c \"import panelmark_web.interactions; import panelmark_web.widgets; print\\('ok'\\)\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html .venv/bin/python -c \"import panelmark_web.interactions; import panelmark_web.widgets; print\\('ok'\\)\")",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -c \"import panelmark_web.interactions; import panelmark_web.widgets; print\\('ok'\\)\")",
+      "WebFetch(domain:raw.githubusercontent.com)",
+      "Bash(python -m pytest -q)",
+      "Bash(PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html python3 -m pytest -q)"
+    ]
+  }
+}

panelmark_web-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/

panelmark_web-0.1.0/CLAUDE.md

@@ -0,0 +1,109 @@
+# Claude Instructions for panelmark-web
+
+This repository is `panelmark-web`, the live web renderer for the panelmark ecosystem.
+
+---
+
+## Scope
+
+The only repositories in scope for this work are:
+
+- `/home/sirrommit/claude_play/panelmark` — read for API docs and contracts
+- `/home/sirrommit/claude_play/panelmark-html` — read for DOM hook contract and CSS
+- `/home/sirrommit/claude_play/panelmark-web` — the implementation target
+
+`panelmark-tui` is **out of scope**. Do not read, search, or reference it.
+
+Do not read `panelmark` or `panelmark-html` source code unless a doc gap is found.
+All information needed is available from the documentation listed below.
+
+---
+
+## Repo initialisation
+
+If this directory does not yet have a `.git` folder, initialise the repo first:
+
+```
+cd /home/sirrommit/claude_play/panelmark-web
+git init
+git remote add origin git@github.com:sirrommit/panelmark-web.git
+```
+
+Do this once. Skip if `.git` already exists.
+
+---
+
+## Implementation plan
+
+Read this before starting any work:
+
+- `/home/sirrommit/claude_play/PANELMARK_WEB_IMPLEMENTATION_PLAN.md`
+
+All open questions in the plan are answered. Do not read `panelmark` or `panelmark-html`
+source to re-answer them.
+
+---
+
+## Required documentation
+
+All information needed to implement `panelmark-web` is in these doc files.
+Read them instead of source code.
+
+| What you need to know | Document | Section |
+|-----------------------|----------|---------|
+| Renderer contract overview | `panelmark/docs/renderer-spec/contract.md` | — |
+| Key string format (`KEY_*` names, control chars, printable chars) | `panelmark/docs/renderer-spec/contract.md` | §"Key string format" |
+| `Shell.handle_key` return values | `panelmark/docs/renderer-spec/contract.md` | §"Return value" |
+| Dirty-region tracking (`dirty_regions`, `mark_all_clean()`, render loop) | `panelmark/docs/renderer-spec/contract.md` | §"Dirty-region tracking" |
+| `Interaction` ABC (`render`, `handle_key`, `get_value`, `set_value`, `is_focusable`) | `panelmark/docs/custom-interactions.md` | — |
+| `DrawCommand` types (`WriteCmd`, `FillCmd`, `CursorCmd`) and `RenderContext` | `panelmark/docs/draw-commands.md` | — |
+| Stable DOM hooks (`data-pm-region`, `.pm-panel-body`, `data-pm-focused`, etc.) | `panelmark-html/docs/hook-contract.md` | — |
+| CSS classes and custom properties provided by `panelmark-html` | `panelmark-html/docs/hook-contract.md` | §"CSS classes", §"CSS custom properties" |
+
+---
+
+## Dependency direction
+
+- `panelmark-web` depends on `panelmark` and `panelmark-html`.
+- Do not make changes to `panelmark` or `panelmark-html` unless a genuine contract gap
+  is found. If a gap is found, stop and get explicit user approval before editing either
+  upstream package.
+
+---
+
+## Validation
+
+Every change must be tested before completion.
+
+- Run the narrowest relevant test first.
+- If the change is broader, run:
+  ```
+  cd /home/sirrommit/claude_play/panelmark-web
+  PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html pytest -q
+  ```
+- For doc-only changes, state explicitly that no automated check exists.
+
+---
+
+## Git
+
+Each completed update should be committed and pushed unless the user says not to.
+
+- Remote: `origin git@github.com:sirrommit/panelmark-web.git`
+- Default branch: `main`
+
+Before pushing:
+
+- Check `git status --short`
+- Confirm only intended files changed
+- Use a clear scoped commit message
+
+---
+
+## Working style
+
+- Follow the phase order in the implementation plan. Complete one phase before starting
+  the next unless the user directs otherwise.
+- Make the smallest change that fully solves the task.
+- Do not add features, abstractions, or error handling beyond what the plan specifies.
+- Keep `panelmark-web` independent of `panelmark-tui` — no imports, no references.

panelmark_web-0.1.0/DOCUMENTATION_TODO.md

@@ -0,0 +1,217 @@
+# Documentation TODO: panelmark-web
+
+All panelmark-docs links in this file use the base:
+`https://github.com/sirrommit/panelmark-docs/blob/main/docs`
+
+---
+
+## README.md
+
+### 1 — Add "Not Implemented" section
+
+The current README lists what is implemented but does not state what is absent.
+After the "## What it includes" section (ends around line 37), add:
+
+```markdown
+## What is not implemented
+
+The following optional interactions and widgets from the portable library are
+**not** implemented in this version:
+
+| Item | Type | Notes |
+|------|------|-------|
+| `TreeView` | Interaction | Not implemented |
+| `DatePicker` | Widget | Not implemented |
+| `Progress` | Widget | Not implemented |
+| `Spinner` | Widget | Not implemented |
+| `Toast` | Widget | Not implemented |
+
+See the [interaction coverage matrix](docs/interaction-coverage.md) for the full
+status of every portable interaction, widget, and draw command.
+```
+
+### 2 — Add also-implemented interactions note
+
+After "## What it includes", before the "Not Implemented" section added above,
+add a note that panelmark-web also implements three frequently-used optional
+interactions beyond the 8 required portable ones:
+
+```markdown
+Beyond the 8 required portable interactions, `panelmark-web` also implements:
+`MenuFunction`, `ListView`, `TableView`.
+```
+
+Add this as a sentence/paragraph below the Interactions and Widgets bullet
+points in "## What it includes".
+
+### 3 — Add CursorCmd note to Compatibility status section
+
+The compatibility section (lines 52–70) already mentions `CursorCmd` is ignored
+on line 58. Confirm line 58 reads:
+`- draw-command execution (\`WriteCmd\`, \`FillCmd\`; \`CursorCmd\` ignored)`
+
+If it reads differently, update it to match exactly. No other change needed in
+that section.
+
+### 4 — Replace relative docs/ links with panelmark-docs links
+
+The following relative links exist in the README and must be updated:
+
+- Line 37: `[docs/interaction-coverage.md](docs/interaction-coverage.md)`
+  → replace with local repo link (this file lives in this repo):
+  `[interaction coverage matrix](docs/interaction-coverage.md)` — **keep as-is**;
+  `docs/interaction-coverage.md` is a repo-local file (see Local docs section below).
+
+- Line 67: second `[docs/interaction-coverage.md](docs/interaction-coverage.md)`
+  → same as above; keep as-is.
+
+- Line 87: `[docs/getting-started.md](docs/getting-started.md)`
+  → replace with panelmark-docs link:
+  `[docs/getting-started.md](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/getting-started.md)`
+
+The `examples/` links on lines 91–92 are repo-local and correct; leave them
+unchanged.
+
+### 5 — Add Documentation Links section
+
+After the "## Quick start" section (currently the last section), add:
+
+```markdown
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Getting Started](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/getting-started.md) | Step-by-step guide: interaction definition, FastAPI/Flask wiring, browser setup |
+| [Interaction Coverage](docs/interaction-coverage.md) | Status matrix: every portable interaction, widget, and draw command |
+| [WebSocket Protocol](docs/protocol.md) | Client→server and server→client message format; key mapping reference |
+| [Hook Usage](docs/hook-usage.md) | How panelmark-web reads and writes the panelmark-html DOM hook contract |
+| [DOM Hook Contract](https://github.com/sirrommit/panelmark-html/blob/main/docs/hook-contract.md) | Stable DOM interface defined by panelmark-html that this package depends on |
+| [Portable Library Spec](https://github.com/sirrommit/panelmark-docs/blob/main/docs/renderer-spec/portable-library.md) | Normative spec for all 8 portable interactions and 6 portable widgets |
+| [Renderer Spec](https://github.com/sirrommit/panelmark-docs/blob/main/docs/renderer-spec/overview.md) | Core renderer contract; compatibility levels; extension policy |
+| [Shell Language](https://github.com/sirrommit/panelmark-docs/blob/main/docs/shell-language/overview.md) | ASCII-art layout syntax reference |
+| [Ecosystem Overview](https://github.com/sirrommit/panelmark-docs/blob/main/docs/ecosystem.md) | How panelmark-web fits into the panelmark package ecosystem |
+```
+
+### 6 — Shorten portable list in "What it includes"
+
+The current "What it includes" section lists all 8 portable interactions and all
+6 portable widgets by name. Shorten to a reference rather than a full
+enumeration. Replace the two bullet points with:
+
+```markdown
+- **Interactions** (`panelmark_web.interactions`): all 8 required portable
+  interactions — `StatusMessage`, `MenuReturn`, `RadioList`, `CheckBox`,
+  `TextBox`, `NestedMenu`, `FormInput`, `DataclassFormInteraction` — plus
+  `MenuFunction`, `ListView`, `TableView`.
+  See [portable library spec](https://github.com/sirrommit/panelmark-docs/blob/main/docs/renderer-spec/portable-library.md)
+  for the full normative specification.
+
+- **Widgets** (`panelmark_web.widgets`): all 6 required portable widgets —
+  `Alert`, `Confirm`, `InputPrompt`, `ListSelect`, `DataclassForm`, `FilePicker`.
+  Web-specific note: widgets are async/non-blocking; see
+  [overview](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/overview.md)
+  for the async widget model.
+```
+
+---
+
+## Local docs/ folder
+
+Three files exist in `docs/`. Each must be audited:
+
+### docs/interaction-coverage.md
+
+- [ ] This file is repo-local and repo-specific (tracks implementation status
+  for this renderer). **Keep it.** Verify the matrix is current:
+  - All 8 portable interactions: `StatusMessage`, `MenuReturn`, `NestedMenu`,
+    `RadioList`, `CheckBox`, `TextBox`, `FormInput`, `DataclassFormInteraction`
+    should be marked implemented.
+  - All 6 portable widgets: `Alert`, `Confirm`, `InputPrompt`, `ListSelect`,
+    `DataclassForm`, `FilePicker` should be marked implemented.
+  - Optional implemented: `MenuFunction`, `ListView`, `TableView` — mark implemented.
+  - Not implemented: `TreeView`, `DatePicker`, `Progress`, `Spinner`, `Toast` —
+    mark not implemented.
+  - Draw commands: `WriteCmd` ✅, `FillCmd` ✅, `CursorCmd` — mark as "accepted,
+    ignored" (not an error, just a no-op).
+  - Update any stale entries and add any missing rows.
+
+### docs/getting-started.md
+
+- [ ] This file is mirrored at
+  `https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/getting-started.md`.
+  Compare both versions:
+  - If panelmark-docs is more complete, update this local file to match and add
+    a header:
+    ```markdown
+    > **Note:** This document is also available on
+    > [panelmark-docs](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/getting-started.md).
+    ```
+  - If the local file is more complete, note the gap for panelmark-docs maintainers;
+    do not delete the local copy.
+  - README link to `docs/getting-started.md` was replaced with the panelmark-docs
+    URL in step 4 above. Confirm the local file is not orphaned by checking for
+    any remaining links to it:
+    `grep -rn "docs/getting-started" . --include="*.md"`
+
+### docs/hook-contract-web.md
+
+- [ ] Read this file. It likely documents how panelmark-web reads/writes the
+  panelmark-html hook contract (equivalent to
+  `https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/hook-usage.md`).
+  - Compare against the panelmark-docs version.
+  - Rename this file to `docs/hook-usage.md` to match the canonical name used in
+    the Documentation table added in step 5 above.
+  - Add a header to the renamed file:
+    ```markdown
+    > **Note:** This document is also mirrored at
+    > [panelmark-docs](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/hook-usage.md).
+    ```
+  - Confirm no other file links to the old name `docs/hook-contract-web.md` after
+    the rename:
+    `grep -rn "hook-contract-web" . --include="*.md"`
+
+### docs/protocol.md (check existence)
+
+- [ ] Run: `ls /home/sirrommit/claude_play/panelmark-web/docs/`
+  If `docs/protocol.md` does not exist, create it by fetching the content from:
+  `https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/protocol.md`
+  and adding this header at the top:
+  ```markdown
+  > **Note:** This document is also mirrored at
+  > [panelmark-docs](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/protocol.md).
+  ```
+  If it already exists, compare against panelmark-docs and sync, adding the same header.
+
+---
+
+## Validation
+
+- [ ] Grep for any remaining relative `docs/getting-started` links in README:
+  `grep -n "docs/getting-started" README.md`
+  Result must be empty (replaced with panelmark-docs URL in step 4).
+
+- [ ] Confirm "Not implemented" section is present:
+  `grep -n "not implemented\|Not Implemented\|What is not" README.md`
+
+- [ ] Confirm `CursorCmd` is mentioned in the Compatibility section:
+  `grep -n "CursorCmd" README.md`
+
+- [ ] Confirm `docs/hook-contract-web.md` has been renamed to `docs/hook-usage.md`:
+  `ls /home/sirrommit/claude_play/panelmark-web/docs/`
+  Should show `hook-usage.md`, not `hook-contract-web.md`.
+
+- [ ] Confirm `docs/protocol.md` exists.
+
+- [ ] Run tests (doc-only change — if no automated check exists, state that
+  explicitly in the commit message):
+  `cd /home/sirrommit/claude_play/panelmark-web && PYTHONPATH=/home/sirrommit/claude_play/panelmark-web:/home/sirrommit/claude_play/panelmark:/home/sirrommit/claude_play/panelmark-html pytest -q`
+
+- [ ] Review `git diff --stat` and confirm only `README.md`, `docs/` files are
+  changed. No Python source changes.
+
+- [ ] Commit:
+  ```
+  docs: add not-implemented list, documentation links section, fix relative links; rename hook-contract-web.md to hook-usage.md
+  ```
+
+- [ ] Push to `origin main`.

panelmark_web-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Timothy Morris PhD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

panelmark_web-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: panelmark-web
+Version: 0.1.0
+Summary: Live web renderer for the panelmark ecosystem
+Project-URL: Repository, https://github.com/sirrommit/panelmark-web
+Author-email: Timothy Morris PhD <sirrommit@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: layout,panelmark,renderer,ui,web,websocket
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.11
+Requires-Dist: panelmark-html>=0.1.0
+Requires-Dist: panelmark>=0.1.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Provides-Extra: fastapi
+Requires-Dist: fastapi; extra == 'fastapi'
+Requires-Dist: uvicorn[standard]; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: flask; extra == 'flask'
+Requires-Dist: flask-sock; extra == 'flask'
+Description-Content-Type: text/markdown
+
+# panelmark-web
+
+Live web session runtime for the [panelmark](https://github.com/sirrommit/panelmark) ecosystem.
+
+---
+
+## What it is
+
+`panelmark-web` sits on top of `panelmark-html`'s static structure and adds a
+real-time browser interface:
+
+- A WebSocket server handler that drives a `panelmark.Shell` instance
+- A draw-command-to-HTML renderer that populates `.pm-panel-body` elements
+- A vanilla-JS browser client that relays keyboard input and applies DOM updates
+- Framework adapters for FastAPI/Starlette (async) and Flask/flask-sock (sync)
+
+Each browser tab corresponds to one `Shell` instance on the server.  The
+WebSocket connection is the session lifetime.
+
+---
+
+## What it includes
+
+Beyond the transport and rendering infrastructure, `panelmark-web` ships
+built-in implementations of the full portable standard library:
+
+- **Interactions** (`panelmark_web.interactions`): all 8 required portable
+  interactions — `StatusMessage`, `MenuReturn`, `RadioList`, `CheckBox`,
+  `TextBox`, `NestedMenu`, `FormInput`, `DataclassFormInteraction` — plus
+  `MenuFunction`, `ListView`, `TableView`.
+  See [portable library spec](https://github.com/sirrommit/panelmark-docs/blob/main/docs/renderer-spec/portable-library.md)
+  for the full normative specification.
+
+- **Widgets** (`panelmark_web.widgets`): all 6 required portable widgets —
+  `Alert`, `Confirm`, `InputPrompt`, `ListSelect`, `DataclassForm`, `FilePicker`.
+  Web-specific note: widgets are async/non-blocking; see
+  [overview](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/overview.md)
+  for the async widget model.
+
+Application code can also supply arbitrary custom `Interaction` objects — any
+`render()` method that returns `WriteCmd` and `FillCmd` commands works out of
+the box.
+
+See [docs/interaction-coverage.md](docs/interaction-coverage.md) for the full
+status matrix.
+
+## What is not implemented
+
+The following optional interactions and widgets from the portable library are
+**not** implemented in this version:
+
+| Item | Type | Notes |
+|------|------|-------|
+| `TreeView` | Interaction | Not implemented |
+| `DatePicker` | Widget | Not implemented |
+| `Progress` | Widget | Not implemented |
+| `Spinner` | Widget | Not implemented |
+| `Toast` | Widget | Not implemented |
+
+See the [interaction coverage matrix](docs/interaction-coverage.md) for the full
+status of every portable interaction, widget, and draw command.
+
+---
+
+## Dependencies
+
+| Package | Role |
+|---------|------|
+| `panelmark` | Shell, Interaction ABC, draw commands |
+| `panelmark-html` | Static page structure and base CSS |
+| `fastapi` / `starlette` *(optional)* | Async ASGI server adapter |
+| `flask` + `flask-sock` *(optional)* | Sync WSGI server adapter |
+
+---
+
+## Compatibility status
+
+`panelmark-web` implements the **core renderer contract** and claims
+**`portable-library-compatible`** status:
+
+- shell hosting via WebSocket session
+- draw-command execution (`WriteCmd`, `FillCmd`; `CursorCmd` ignored)
+- focus routing and dirty-region tracking
+- exit signal handling
+- all 8 required portable interactions (`panelmark_web.interactions`)
+- all 6 required portable widgets (`panelmark_web.widgets`)
+
+**Web note:** The portable-library spec describes widgets as blocking
+(`widget.show(sh)` returns after the user acts).  In `panelmark-web` the
+session is async — assign the widget to a panel region and `signal_return()`
+delivers the result when the user acts.  Constructor signatures and value
+semantics match the spec exactly.
+
+See [docs/interaction-coverage.md](docs/interaction-coverage.md) for the
+full status matrix.
+
+---
+
+## Install
+
+```bash
+pip install panelmark-web[fastapi]   # FastAPI / Starlette
+pip install panelmark-web[flask]     # Flask + flask-sock
+```
+
+---
+
+## Quick start
+
+See [docs/getting-started.md](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/getting-started.md) for a step-by-step
+guide including interaction definition, server wiring, and browser setup.
+
+See [examples/fastapi_app.py](examples/fastapi_app.py) and
+[examples/flask_app.py](examples/flask_app.py) for working server examples.
+
+---
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Getting Started](https://github.com/sirrommit/panelmark-docs/blob/main/docs/panelmark-web/getting-started.md) | Step-by-step guide: interaction definition, FastAPI/Flask wiring, browser setup |
+| [Interaction Coverage](docs/interaction-coverage.md) | Status matrix: every portable interaction, widget, and draw command |
+| [WebSocket Protocol](docs/protocol.md) | Client→server and server→client message format; key mapping reference |
+| [Hook Usage](docs/hook-usage.md) | How panelmark-web reads and writes the panelmark-html DOM hook contract |
+| [DOM Hook Contract](https://github.com/sirrommit/panelmark-html/blob/main/docs/hook-contract.md) | Stable DOM interface defined by panelmark-html that this package depends on |
+| [Portable Library Spec](https://github.com/sirrommit/panelmark-docs/blob/main/docs/renderer-spec/portable-library.md) | Normative spec for all 8 portable interactions and 6 portable widgets |
+| [Renderer Spec](https://github.com/sirrommit/panelmark-docs/blob/main/docs/renderer-spec/overview.md) | Core renderer contract; compatibility levels; extension policy |
+| [Shell Language](https://github.com/sirrommit/panelmark-docs/blob/main/docs/shell-language/overview.md) | ASCII-art layout syntax reference |
+| [Ecosystem Overview](https://github.com/sirrommit/panelmark-docs/blob/main/docs/ecosystem.md) | How panelmark-web fits into the panelmark package ecosystem |