reflex-perspective 0.1.0__tar.gz

reflex_perspective-0.1.0/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 [yyyy] [name of copyright owner]
+
+   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.

reflex_perspective-0.1.0/PKG-INFO

@@ -0,0 +1,322 @@
+Metadata-Version: 2.4
+Name: reflex-perspective
+Version: 0.1.0
+Summary: Perspective for Reflex: a WebAssembly analytics viewer (datagrid + WebGL charts) for large and streaming datasets, with client-only, server-only and replicated modes.
+Author-email: Ernesto Crespo <ecrespo@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ecrespo/reflex-perspective
+Project-URL: Source, https://github.com/ecrespo/reflex-perspective
+Project-URL: Issues, https://github.com/ecrespo/reflex-perspective/issues
+Project-URL: Perspective, https://perspective-dev.github.io
+Keywords: reflex,reflex-custom-components,perspective,datagrid,pivot,streaming,data-visualization,webassembly
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: reflex>=0.9.12
+Provides-Extra: server
+Requires-Dist: perspective-python==5.5.1; python_version >= "3.11" and extra == "server"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: httpx; extra == "dev"
+Requires-Dist: perspective-python==5.5.1; python_version >= "3.11" and extra == "dev"
+Dynamic: license-file
+
+# reflex-perspective
+
+A [Reflex](https://reflex.dev) custom component for [Perspective](https://perspective-dev.github.io) —
+the WebAssembly analytics engine and interactive viewer (datagrid + WebGL charts) built for
+large and streaming datasets.
+
+![Explorer](docs/images/explorer.png)
+
+- **All three Perspective data architectures**
+  - *Client-only*: data from Reflex state, a URL (CSV / JSON / NDJSON / Arrow) or a schema lives in a browser WebWorker.
+  - *Server-only (virtual)*: tables live in `perspective-python` **inside the Reflex backend**; only the visible cells cross the wire.
+  - *Client/server replicated*: the browser keeps a live copy of a server table and computes views locally.
+- **Declarative props** for the whole `ViewerConfig` (`plugin`, `group_by`, `split_by`, `columns`, `filter`, `sort`, `expressions`, `aggregates`, `columns_config`, `theme`, `settings`, ...) mapped to `restore()`.
+- **Multi-panel workspaces** (`restoreWorkspace`) with master panels and global cross-filters.
+- **Streaming** through props (`update_rows`, `remove_keys`) or straight from event handlers (`rp.update`).
+- **Perspective Custom Events as Reflex events**: `on_click`, `on_select`, `on_config_update`, `on_global_filter_update`, `on_layout_update`, `on_load`, `on_error`, ...
+- **Imperative API from Python**: `rp.save`, `rp.restore`, `rp.download`, `rp.copy`, `rp.export`, `rp.reset`, `rp.toggle_config`, `rp.update`, `rp.remove`, `rp.clear`, `rp.add_panel`, ...
+- All 16 bundled themes, every datagrid and chart plugin (X/Y Bar, Line, Area, Scatter, Density, Treemap, Sunburst, Heatmap, Candlestick, OHLC, Map Scatter/Line/Density).
+- SSR-safe lazy WASM bootstrap, automatic WebSocket reconnection, works in `reflex run` dev and `--env prod`.
+
+Built against **Reflex 0.9.12** and **Perspective 5.5.1** (`@perspective-dev/*` npm packages and `perspective-python`).
+
+## Installation
+
+```bash
+pip install reflex-perspective            # client-only mode
+pip install "reflex-perspective[server]"  # + perspective-python for server modes
+```
+
+The npm packages are installed by Reflex automatically on the first `reflex run`.
+The client-only component works on Python 3.10+; the `server` extra needs Python 3.11+
+(`perspective-python` 5.x only publishes `cp311-abi3` wheels).
+
+## Quick start (client-only)
+
+```python
+import reflex as rx
+import reflex_perspective as rp
+
+
+class State(rx.State):
+    rows: list[dict] = [
+        {"region": "East", "product": "A", "sales": 120.5},
+        {"region": "West", "product": "B", "sales": 98.1},
+    ]
+    plugin: str = "Y Bar"
+
+    @rx.event
+    def clicked(self, detail: dict):
+        print(detail["row"], detail["config"]["filter"])
+
+
+def index():
+    return rp.perspective_viewer(
+        id="sales",
+        data=State.rows,  # list of rows, dict of columns, or CSV text
+        plugin=State.plugin,
+        group_by=["region"],
+        split_by=["product"],
+        columns=["sales"],
+        theme="Pro Dark",
+        on_click=State.clicked,
+        height="500px",
+    )
+
+
+app = rx.App()
+app.add_page(index)
+```
+
+Changing any prop re-applies only the difference with `restore()`; changing `data` calls
+`table.replace()` and keeps the user's view.
+
+## Server-hosted tables (perspective-python)
+
+```python
+import reflex as rx
+import reflex_perspective as rp
+from reflex_perspective import server as ps
+
+hub = ps.get_hub()  # a perspective.Server + local client
+hub.table(big_dataframe, name="orders", index="order_id")
+
+app = rx.App(api_transformer=ps.perspective_api())  # WebSocket at /perspective
+# or: ps.mount(app)  (keeps any existing api_transformer)
+
+
+def page():
+    return rx.hstack(
+        # virtual: pivots/sorts run in Python, only the viewport is sent
+        rp.perspective_viewer(server_url="/perspective", server_table="orders"),
+        # replicated: the browser keeps a synced copy and computes locally
+        rp.perspective_viewer(
+            server_url="/perspective", server_table="orders", server_mode="replicated"
+        ),
+    )
+
+
+class State(rx.State):
+    @rx.event
+    def add_order(self):
+        hub.update("orders", [{"order_id": 42, "qty": 3}])  # every viewer updates
+```
+
+`server_url` may be a path (resolved against the Reflex backend URL, which also handles
+the dev setup where frontend and backend run on different ports) or an absolute `ws://` URL
+of any Perspective server. Feed tables from background tasks, lifespan tasks
+(`ps.run_periodically(fn, interval)`) or plain threads — the hub is thread-safe and the
+WebSocket handler marshals messages back onto the event loop. Engine requests run in the
+event loop's default thread pool (pass `executor=` to `perspective_api()` / `mount()` to use
+your own), so a heavy pivot on a large table never blocks other Reflex events.
+
+The endpoint checks the browser `Origin` header against Reflex's `cors_allowed_origins`
+(or `allowed_origins=[...]` passed to `perspective_api()` / `mount()`), closing foreign
+connections with code 1008. Set explicit origins in production: the Reflex default (`"*"`)
+lets any site open the socket, and hosted tables are writable over it.
+
+`PerspectiveHub` helpers: `table()`, `get_table()`, `has_table()`, `table_names()`,
+`update()`, `remove()`, `clear()`, `size()`, `query(name, **view_config)` and
+`delete_table()`.
+
+## Streaming
+
+```python
+rp.perspective_viewer(
+    id="ticks",
+    schema={"time": "datetime", "symbol": "string", "price": "float"},
+    limit=5000,  # rolling window
+    update_rows=State.batch,  # every new list is applied with table.update()
+    plugin="Y Line",
+    group_by=["time"],
+    split_by=["symbol"],
+    columns=["price"],
+)
+
+
+# or push rows without storing them in state:
+@rx.event
+def burst(self):
+    return rp.update("ticks", rows)
+```
+
+## Workspaces
+
+```python
+rp.perspective_viewer(
+    data=State.rows,
+    workspace={
+        "masters": ["regions"],  # selections here become global filters
+        "layout": {
+            "type": "split-layout",
+            "orientation": "horizontal",
+            "sizes": [0.4, 0.6],
+            "children": [
+                {"type": "tab-layout", "tabs": ["regions"]},
+                {"type": "tab-layout", "tabs": ["chart"]},
+            ],
+        },
+        "panels": {
+            "regions": {
+                "plugin": "Datagrid",
+                "group_by": ["Region"],
+                "columns": ["Sales"],
+            },
+            "chart": {
+                "plugin": "Treemap",
+                "group_by": ["Category"],
+                "columns": ["Sales"],
+            },
+        },
+    },
+    on_global_filter_update=State.set_filters,
+)
+```
+
+Panels without a `table` in the `workspace` prop are bound to the viewer's own table
+automatically. `rp.restore_workspace()` and `rp.add_panel()` pass their config through
+unchanged, so include `table` there.
+
+## Props
+
+| Prop | Description |
+| --- | --- |
+| `data` | Rows (`list[dict]`), columns (`dict[str, list]`) or CSV text. |
+| `schema` | `{"col": "string" \| "integer" \| "float" \| "boolean" \| "date" \| "datetime"}`; enforces types. |
+| `index` / `limit` | Primary key (upserts) or rolling row limit. |
+| `table_name` | Table name (defaults to the component `id`); saved configs reference it. |
+| `url`, `url_format` | Load CSV / JSON / NDJSON / Arrow from a URL. |
+| `server_url`, `server_table`, `server_mode` | Connect to a Perspective WebSocket server (`"server"` or `"replicated"`). |
+| `update_rows`, `remove_keys` | Streaming: applied every time the prop changes. |
+| `config` | Full `ViewerConfigUpdate`; the shortcut props below are merged on top. |
+| `plugin`, `columns`, `group_by`, `split_by`, `filter`, `filter_op`, `sort`, `expressions`, `aggregates`, `group_by_depth`, `group_rollup_mode`, `split_rollup_mode`, `plugin_config`, `columns_config`, `theme`, `title`, `settings` | View configuration. |
+| `edit_mode` | Datagrid mode: `READ_ONLY`, `EDIT`, `SELECT_ROW`, `SELECT_COLUMN`, `SELECT_REGION`, `SELECT_ROW_TREE`. |
+| `workspace` | Multi-panel `WorkspaceConfigUpdate`. |
+| `auto_size`, `auto_pause`, `throttle`, `plugin_limits` | Render policy. |
+
+Styling props (`height`, `width`, `border_radius`, ...) apply to the `<perspective-viewer>` element (default height 600px).
+
+## Events
+
+| Event | Payload |
+| --- | --- |
+| `on_load` | `{"table", "schema", "num_rows", "source"}` |
+| `on_config_update` | Full saved viewer config after any change |
+| `on_click` | `{"row", "column_names", "config", "panel"}` (`config.filter` selects the clicked datum) |
+| `on_select` | `{"selected", "row", "column_names", "insert_filters", "remove_filters", "panel"}` |
+| `on_global_filter_update` | List of filters (workspaces) |
+| `on_layout_update` / `on_active_panel_update` | Panel ids / active panel id |
+| `on_toggle_settings` | `bool` |
+| `on_disconnect` / `on_error` | URL / message |
+
+A controlled loop (`config=State.cfg`, `on_config_update=State.set_cfg`) is safe: the
+component does not re-apply a config the viewer itself just emitted.
+
+## Actions
+
+All return an `EventSpec`, usable in triggers (`on_click=rp.download("v")`) or returned from
+handlers. Arguments may be plain values or state vars. Result-returning actions take a
+`callback` event handler.
+
+`save(id, callback)`, `restore(id, config)`, `save_workspace(id, callback)`,
+`restore_workspace(id, workspace)`, `reset(id, all=False)`, `toggle_config(id, force=None)`,
+`download(id, method="csv")`, `copy(id, method="csv")`, `export(id, callback, method="csv")`,
+`update(id, rows)`, `remove(id, keys)`, `replace(id, data)`, `clear(id)`,
+`table_size(id, callback)`, `table_schema(id, callback)`, `add_panel(id, config)`, `resize(id)`.
+
+`export` delivers text for `csv`, `json`, `ndjson`, `html` and `json-config`, and a base64
+`data:` URL for the binary methods (`arrow*`, and `plugin`, which is a PNG image).
+
+Export methods: `rp.EXPORT_METHODS`. Plugins: `rp.PLUGINS`. Themes: `rp.THEMES`.
+Aggregates: `rp.AGGREGATES`.
+
+## Demo app
+
+```bash
+uv venv -p 3.12 && uv pip install -e ".[server]"
+cd perspective_demo
+uv run reflex run
+```
+
+| Page | What it shows |
+| --- | --- |
+| `/` Explorer | Declarative props driven by state controls, click/select/config events |
+| `/streaming` | Background task streaming through `update_rows`, `rp.update` bursts, callbacks |
+| `/server` | perspective-python tables over a WebSocket: live market feed, 250k-row virtual table, replicated mode, Python-side queries |
+| `/workspace` | Multi-panel dashboards, master panels, global filters, `saveWorkspace()` |
+| `/api` | Imperative actions, named layouts, editable datagrid, mutations, event log |
+| `/gallery` | Every chart plugin with a different theme |
+
+| | |
+| --- | --- |
+| ![Streaming](docs/images/streaming.png) | ![Workspace](docs/images/workspace.png) |
+| ![Server](docs/images/server.png) | ![Gallery](docs/images/gallery.png) |
+
+## Notes
+
+- Keep `perspective-python` and the npm packages on the same version (`rp.PERSPECTIVE_VERSION`); the WebSocket protocol is versioned together.
+- Server tables live in the backend process. With several backend workers each worker has its own hub; use a single worker or an external Perspective server (`server_url="ws://..."`) for shared tables.
+- Apart from the `Origin` check, the WebSocket endpoint has no authentication, just like Perspective's own handlers. Any client that can reach it can read **and modify** every hosted table. Put it behind your auth (e.g. a Starlette middleware in `api_transformer`) before exposing it to untrusted networks.
+- `update_rows` / `rp.update` write to the viewer's own table. In `server` mode that's the shared hosted table; in `replicated` mode it's only the browser replica (write through the hub to reach every viewer).
+- On the very first `reflex run` after installing, Vite may pre-bundle the new npm dependencies while the page loads; reload once if the viewer does not appear.
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest                      # unit tests
+uvx ruff check . && uvx ruff format --check .
+uv build                           # sdist + wheel in dist/
+```
+
+CI runs on every push and PR to `main` / `develop`: **Quality** (ruff, a JSX syntax check,
+pytest on Python 3.10–3.13, a build + `twine check` with a wheel-content check, and a
+`reflex compile` of the demo) and **Security** (CodeQL, Bandit, pip-audit, gitleaks and
+dependency review).
+
+### Releasing
+
+1. Bump `version` in `pyproject.toml` and `__version__` in
+   `custom_components/reflex_perspective/__init__.py` (CI checks they match).
+2. Merge to `main`, then tag and push: `git tag v0.1.1 && git push origin v0.1.1`.
+3. The **Release** workflow checks the tag against the version, runs the checks again,
+   builds, publishes to PyPI (Trusted Publishing) and creates the GitHub release with the
+   artifacts attached.
+
+## License
+
+Apache-2.0. Perspective is © the Perspective Authors, Apache-2.0.