better-rtplot 0.2.5__tar.gz → 0.4.0__tar.gz

better_rtplot-0.4.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.1
+Name: better-rtplot
+Version: 0.4.0
+Summary: 
+License: GPL V3.0
+Author: jmontp
+Author-email: jmontp@umich.edu
+Requires-Python: >=3.9,<3.13
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: browser
+Provides-Extra: server
+Requires-Dist: aiohttp (>=3.9.0) ; extra == "browser"
+Requires-Dist: numpy (>=1.23.5)
+Requires-Dist: pyqtgraph (>=0.13.0) ; extra == "server"
+Requires-Dist: pyside6 (>6.4.0) ; extra == "server"
+Requires-Dist: pyzmq (>=25.0.0)
+Description-Content-Type: text/markdown
+
+# rtplot — real-time plotting over ZMQ
+
+**rtplot** pushes live data from a Python script to a browser plot —
+locally or across a network — in a few lines of code. The plot page
+also hosts interactive widgets (buttons, sliders, dials, numeric / text
+displays) that feed values back to the sender in real time.
+
+Typical use: a robot or data-acquisition script runs on a Raspberry Pi,
+and you watch signals and tweak gains from a laptop on the same Wi-Fi.
+
+---
+
+## How it works
+
+Two processes talking over ZMQ, plus a browser viewer:
+
+```mermaid
+flowchart TD
+    script["Your Python script<br/>send_array() · poll_controls()"]
+    subgraph server["rtplot-server"]
+        browser["browser tab<br/>localhost:8050"]
+    end
+    script -- "data :5555" --> server
+    server -- "controls :5556" --> script
+```
+
+Sender and server don't have to be on the same machine — see the
+[networking guide](docs/networking.md).
+
+---
+
+## Install
+
+**Server** — grab the prebuilt binary from the
+[Releases page](https://github.com/jmontp/rtplot/releases):
+
+| Platform | Asset |
+|---|---|
+| Windows | `rtplot-server-<version>-windows-x64.exe` |
+| Linux | `rtplot-server-<version>-linux-x86_64.tar.gz` |
+| macOS (Apple Silicon) | `rtplot-server-<version>-macos-arm64.tar.gz` |
+
+No Python needed on the viewing machine. On Windows the binary opens
+a small Tk status window showing the listening URL.
+
+**Client** — pip install in the env that runs your script:
+
+```bash
+pip install better-rtplot
+```
+
+(If you'd rather run the server from Python too, use
+`pip install "better-rtplot[browser]"` — see the
+[API reference](docs/api.md#install-detail).)
+
+---
+
+## Your first plot
+
+```mermaid
+flowchart TD
+    t1["terminal 1: start the server"]
+    t2["terminal 2: run your script"]
+    br["browser: open localhost:8050"]
+    t1 --> t2 --> br
+```
+
+**Terminal 1 — start the server.** Run the prebuilt `rtplot-server`
+binary you downloaded above. Open `http://localhost:8050` in a
+browser — the page is blank until data arrives.
+
+**Terminal 2 — run your sender script.** Save as `my_plot.py`:
+
+```python
+from rtplot import client
+import time
+
+client.local_plot()
+client.initialize_plots(["my signal"])
+
+for i in range(1000):
+    client.send_array(i * 0.01)
+    time.sleep(0.01)
+```
+
+```bash
+python my_plot.py
+```
+
+A rising line now draws itself in the browser tab.
+
+---
+
+## Highlights
+
+- **Fast.** Binary WebSocket deltas up to 1 kHz; the browser coalesces
+  samples into one repaint per `requestAnimationFrame`, so rendering
+  tracks your monitor refresh rate regardless of sample rate.
+- **Browser-based.** aiohttp + uPlot, no desktop GUI toolkit, works
+  over SSH port forwarding.
+- **Remote-friendly.** Sender or plot host can bind. Live Bind /
+  Connect buttons retarget without restart.
+- **Config lives with the data.** The sender declares plot layout.
+- **Interactive controls.** Buttons, sliders, dials, displays — polled
+  from your loop, no threads, no callbacks.
+- **Static HTML snapshots.** `save_snapshot("out.html")` writes a
+  self-contained ~65 KB file with the current trace embedded.
+
+---
+
+## Where to go next
+
+- **[API reference](docs/api.md)** — every `rtplot.client` function,
+  the plot-layout schema, interactive controls, snapshots, browser UI,
+  and `rtplot-server` CLI flags.
+- **[Networking guide](docs/networking.md)** — Mode A vs. Mode B,
+  viewing from a phone or second laptop, the WSL2 wrinkle, Cloudflare
+  Tunnel, Tailscale.
+- **[Examples](examples/README.md)** — runnable scripts with embedded
+  HTML snapshots you can open offline.
+
+---
+
+Issues and feature requests:
+[github.com/jmontp/rtplot/issues](https://github.com/jmontp/rtplot/issues).
+

better_rtplot-0.4.0/README.md

@@ -0,0 +1,125 @@
+# rtplot — real-time plotting over ZMQ
+
+**rtplot** pushes live data from a Python script to a browser plot —
+locally or across a network — in a few lines of code. The plot page
+also hosts interactive widgets (buttons, sliders, dials, numeric / text
+displays) that feed values back to the sender in real time.
+
+Typical use: a robot or data-acquisition script runs on a Raspberry Pi,
+and you watch signals and tweak gains from a laptop on the same Wi-Fi.
+
+---
+
+## How it works
+
+Two processes talking over ZMQ, plus a browser viewer:
+
+```mermaid
+flowchart TD
+    script["Your Python script<br/>send_array() · poll_controls()"]
+    subgraph server["rtplot-server"]
+        browser["browser tab<br/>localhost:8050"]
+    end
+    script -- "data :5555" --> server
+    server -- "controls :5556" --> script
+```
+
+Sender and server don't have to be on the same machine — see the
+[networking guide](docs/networking.md).
+
+---
+
+## Install
+
+**Server** — grab the prebuilt binary from the
+[Releases page](https://github.com/jmontp/rtplot/releases):
+
+| Platform | Asset |
+|---|---|
+| Windows | `rtplot-server-<version>-windows-x64.exe` |
+| Linux | `rtplot-server-<version>-linux-x86_64.tar.gz` |
+| macOS (Apple Silicon) | `rtplot-server-<version>-macos-arm64.tar.gz` |
+
+No Python needed on the viewing machine. On Windows the binary opens
+a small Tk status window showing the listening URL.
+
+**Client** — pip install in the env that runs your script:
+
+```bash
+pip install better-rtplot
+```
+
+(If you'd rather run the server from Python too, use
+`pip install "better-rtplot[browser]"` — see the
+[API reference](docs/api.md#install-detail).)
+
+---
+
+## Your first plot
+
+```mermaid
+flowchart TD
+    t1["terminal 1: start the server"]
+    t2["terminal 2: run your script"]
+    br["browser: open localhost:8050"]
+    t1 --> t2 --> br
+```
+
+**Terminal 1 — start the server.** Run the prebuilt `rtplot-server`
+binary you downloaded above. Open `http://localhost:8050` in a
+browser — the page is blank until data arrives.
+
+**Terminal 2 — run your sender script.** Save as `my_plot.py`:
+
+```python
+from rtplot import client
+import time
+
+client.local_plot()
+client.initialize_plots(["my signal"])
+
+for i in range(1000):
+    client.send_array(i * 0.01)
+    time.sleep(0.01)
+```
+
+```bash
+python my_plot.py
+```
+
+A rising line now draws itself in the browser tab.
+
+---
+
+## Highlights
+
+- **Fast.** Binary WebSocket deltas up to 1 kHz; the browser coalesces
+  samples into one repaint per `requestAnimationFrame`, so rendering
+  tracks your monitor refresh rate regardless of sample rate.
+- **Browser-based.** aiohttp + uPlot, no desktop GUI toolkit, works
+  over SSH port forwarding.
+- **Remote-friendly.** Sender or plot host can bind. Live Bind /
+  Connect buttons retarget without restart.
+- **Config lives with the data.** The sender declares plot layout.
+- **Interactive controls.** Buttons, sliders, dials, displays — polled
+  from your loop, no threads, no callbacks.
+- **Static HTML snapshots.** `save_snapshot("out.html")` writes a
+  self-contained ~65 KB file with the current trace embedded.
+
+---
+
+## Where to go next
+
+- **[API reference](docs/api.md)** — every `rtplot.client` function,
+  the plot-layout schema, interactive controls, snapshots, browser UI,
+  and `rtplot-server` CLI flags.
+- **[Networking guide](docs/networking.md)** — Mode A vs. Mode B,
+  viewing from a phone or second laptop, the WSL2 wrinkle, Cloudflare
+  Tunnel, Tailscale.
+- **[Examples](examples/README.md)** — runnable scripts with embedded
+  HTML snapshots you can open offline.
+
+---
+
+Issues and feature requests:
+[github.com/jmontp/rtplot/issues](https://github.com/jmontp/rtplot/issues).

{better_rtplot-0.2.5 → better_rtplot-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "better-rtplot"
-version = "0.2.5"
+version = "0.4.0"
 description = ""
 authors = ["jmontp <jmontp@umich.edu>"]
 license = "GPL V3.0"
@@ -13,15 +13,13 @@ python = ">= 3.9, < 3.13"
 numpy = ">= 1.23.5"
 pyzmq = ">= 25.0.0"
 
-pandas = {version = ">= 1.5.3", optional = true}
-pyarrow = {version=">= 11.0.0", optional = true}
 pyqtgraph = {version = ">= 0.13.0", optional = true}
 pyside6 = {version = "> 6.4.0", optional = true}
 aiohttp = {version = ">= 3.9.0", optional = true}
 
 [tool.poetry.extras]
-server = ["pyqtgraph", "pyside6", "pandas", "pyarrow"]
-browser = ["aiohttp", "pandas", "pyarrow"]
+server = ["pyqtgraph", "pyside6"]
+browser = ["aiohttp"]
 
 
 [build-system]