From 61087b1588711c201d0dbfb26840e04a7da9bac2 Mon Sep 17 00:00:00 2001 From: ruv Date: Sun, 24 May 2026 12:16:18 -0400 Subject: [PATCH] docs(adr-117): point root README + user-guide at the v2 pip wheel MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Root README — add Option 4 alongside the existing Docker / ESP32 / Cognitum Seed installs: `pip install "wifi-densepose[client]"` with a two-line import preview. - User-guide §Installation — replace the stale "From Source (Python)" block (which referenced legacy v1 extras `[gpu]` and `[all]` that don't exist in v2) with a brief "Python wheel (pip) — ADR-117" section: what the wheel is, install commands, two-line example, tombstone caveat, and the `maturin develop` source-build path for contributors. Refs: docs/adr/ADR-117-pip-wifi-densepose-modernization.md Refs: #785 Co-Authored-By: claude-flow --- README.md | 5 +++++ docs/user-guide.md | 35 +++++++++++++++++++++++++---------- 2 files changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9950f3a2..50a50978 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,11 @@ idf.py -p COM6 flash node scripts/rf-scan.js --port 5006 # Live RF room scan node scripts/snn-csi-processor.js --port 5006 # SNN real-time learning node scripts/mincut-person-counter.js --port 5006 # Correct person counting + +# Option 4: Python — talk to a RuView node from your own code (ADR-117) +pip install "wifi-densepose[client]" # ~250 KB compiled wheel, abi3-py310 +# from wifi_densepose import BreathingExtractor, HeartRateExtractor +# from wifi_densepose.client import SensingClient, RuViewMqttClient ``` > [!NOTE] diff --git a/docs/user-guide.md b/docs/user-guide.md index 87317c81..8f5507be 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -164,19 +164,34 @@ cargo add wifi-densepose-wasm-edge See the full crate list and dependency order in [CLAUDE.md](../CLAUDE.md#crate-publishing-order). -### From Source (Python) +### Python wheel (pip) — ADR-117 + +The `wifi-densepose` PyPI wheel is a PyO3 binding to the Rust core. It +ships compiled DSP (~250 KB, Linux/macOS/Windows × abi3-py310) plus an +opt-in pure-Python WebSocket/MQTT client for talking to a live RuView +sensing-server. + +```bash +pip install wifi-densepose # core DSP only +pip install "wifi-densepose[client]" # + websockets + paho-mqtt +``` + +```python +from wifi_densepose import BreathingExtractor, HeartRateExtractor +from wifi_densepose.client import SensingClient, RuViewMqttClient +``` + +The legacy `wifi-densepose==1.1.0` FastAPI server is end-of-life; +`wifi-densepose==1.99.0` is a tombstone that raises `ImportError` +with a migration URL. + +To build the wheel from source (e.g. for a local change): ```bash git clone https://github.com/ruvnet/RuView.git -cd RuView - -pip install -r requirements.txt -pip install -e . - -# Or via PyPI -pip install wifi-densepose -pip install wifi-densepose[gpu] # GPU acceleration -pip install wifi-densepose[all] # All optional deps +cd RuView/python +pip install maturin>=1.7 +maturin develop --release ``` ### Guided Installer