reflex-jupyter-renderer-react 0.1.0__tar.gz

reflex_jupyter_renderer_react-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ernesto Crespo
+
+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.

reflex_jupyter_renderer_react-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: reflex-jupyter-renderer-react
+Version: 0.1.0
+Summary: A native Reflex component wrapping jupyter-renderer-react to render Jupyter notebooks (.ipynb) in pure Python.
+Author-email: Ernesto Crespo <ecrespo@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/ecrespo/reflex-jupyter-renderer-react
+Project-URL: Repository, https://github.com/ecrespo/reflex-jupyter-renderer-react
+Project-URL: Issues, https://github.com/ecrespo/reflex-jupyter-renderer-react/issues
+Project-URL: Documentation, https://github.com/ecrespo/reflex-jupyter-renderer-react#readme
+Project-URL: Changelog, https://github.com/ecrespo/reflex-jupyter-renderer-react/releases
+Project-URL: PyPI, https://pypi.org/project/reflex-jupyter-renderer-react/
+Project-URL: Upstream, https://github.com/iomete/jupyter-renderer-react
+Keywords: reflex,reflex-custom-components,jupyter,notebook,ipynb,renderer,react,component,visualization
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: reflex>=0.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# reflex-jupyter-renderer-react
+
+[![PyPI version](https://img.shields.io/pypi/v/reflex-jupyter-renderer-react.svg)](https://pypi.org/project/reflex-jupyter-renderer-react/)
+[![Python versions](https://img.shields.io/pypi/pyversions/reflex-jupyter-renderer-react.svg)](https://pypi.org/project/reflex-jupyter-renderer-react/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ecrespo/reflex-jupyter-renderer-react/blob/main/LICENSE)
+[![GitHub](https://img.shields.io/badge/GitHub-ecrespo%2Freflex--jupyter--renderer--react-181717?logo=github)](https://github.com/ecrespo/reflex-jupyter-renderer-react)
+
+- **Source:** https://github.com/ecrespo/reflex-jupyter-renderer-react
+- **PyPI:** https://pypi.org/project/reflex-jupyter-renderer-react/
+- **Issues:** https://github.com/ecrespo/reflex-jupyter-renderer-react/issues
+- **Upstream React library:** https://github.com/iomete/jupyter-renderer-react
+
+A native [Reflex](https://reflex.dev/) component that wraps the
+[`jupyter-renderer-react`](https://github.com/iomete/jupyter-renderer-react) React
+library, so you can render **Jupyter notebooks (`.ipynb`)** in a Reflex app —
+with syntax highlighting, markdown, rich outputs, theming, collapsible cells and
+copy-to-clipboard — in **pure Python**. No HTML, no `iframe`, no hand-written
+JavaScript.
+
+```python
+import reflex as rx
+from reflex_jupyter_renderer_react import (
+    jupyter_notebook_viewer, Notebook, MarkdownCell, CodeCell, stream_output,
+)
+
+nb = Notebook(cells=[
+    MarkdownCell("# Hello, notebook"),
+    CodeCell("print('hi')", execution_count=1, outputs=[stream_output("hi\n")]),
+])
+
+def index() -> rx.Component:
+    return jupyter_notebook_viewer(notebook=nb.to_dict(), theme="dark")
+
+app = rx.App()
+app.add_page(index)
+```
+
+## Why a native component?
+
+| iframe / pre-rendered HTML | native component (this package) |
+|---|---|
+| Isolated from app state | Wired into Reflex state via events (`on_file_load`, `on_error`, …) |
+| Tied to static files/routes | Reusable, `pip install`-able |
+| Untyped JSON edited by hand | Typed Python builders for notebooks |
+| External hosting / manual embedding | npm dependency resolved by Reflex automatically |
+
+## Install
+
+```bash
+pip install reflex-jupyter-renderer-react
+# or, with uv:
+uv add reflex-jupyter-renderer-react
+# or, from this repo (editable):
+uv pip install -e .
+```
+
+Reflex installs the underlying npm package (`jupyter-renderer-react`) into the
+compiled frontend automatically on the first `reflex run`.
+
+## Usage
+
+### Three ways to supply a notebook
+
+```python
+from reflex_jupyter_renderer_react import (
+    jupyter_notebook_viewer, JupyterNotebookViewer, Notebook, MarkdownCell, CodeCell,
+    load_notebook,
+)
+
+# 1) Typed Python builders
+nb = Notebook(cells=[MarkdownCell("# Title"), CodeCell("1 + 1", execution_count=1)])
+jupyter_notebook_viewer(notebook=nb.to_dict())
+
+# 2) A raw JSON string
+jupyter_notebook_viewer(notebook='{"cells": [], "nbformat": 4, "nbformat_minor": 4}')
+# or: JupyterNotebookViewer.from_json(json_str)
+
+# 3) Load from a URL or from disk
+JupyterNotebookViewer.from_url("https://example.com/notebook.ipynb")
+jupyter_notebook_viewer(notebook=load_notebook("assets/demo-example.ipynb"))
+```
+
+### Props
+
+| Prop | Type | Default | Description |
+|---|---|---|---|
+| `notebook` | `dict \| str` | required | Parsed dict, JSON string, or `{"filePath": "..."}`. |
+| `theme` | `str \| dict` | `"light"` | `"light"`, `"dark"`, or a custom theme object. |
+| `show_cell_numbers` | `bool` | `True` | Show execution count for code cells. |
+| `show_outputs` | `bool` | `True` | Render cell outputs. |
+| `collapsible` | `bool` | `False` | Allow cells to collapse. |
+| `copyable` | `bool` | `True` | Copy button on code cells. |
+| `class_names` | `dict` | `{}` | Per-part class names (`classNames`). |
+| `styles` | `dict` | `{}` | Per-part inline styles (`styles`). |
+| `fetch_options` | `dict` | `{}` | `{"headers": {...}, "timeout": 10000}` for URL loading. |
+
+> Reflex converts `snake_case` props to `camelCase` automatically
+> (`show_cell_numbers` → `showCellNumbers`).
+
+### Events → Python
+
+```python
+class State(rx.State):
+    status: str = "idle"
+
+    @rx.event
+    def loaded(self, notebook: dict):
+        self.status = f"{len(notebook.get('cells', []))} cells loaded"
+
+    @rx.event
+    def failed(self, message: str):
+        self.status = f"error: {message}"
+
+JupyterNotebookViewer.from_url(
+    "https://example.com/notebook.ipynb",
+    fetch_options={"timeout": 10000},
+    on_file_load=State.loaded,
+    on_file_error=State.failed,
+)
+```
+
+| Event | Payload | Fires when |
+|---|---|---|
+| `on_file_load` | `notebook: dict` | A notebook is fetched from a `filePath`. |
+| `on_file_error` | `message: str` | File loading fails (network / 404 / timeout). |
+| `on_error` | `message: str` | Parsing / rendering fails. |
+
+## Demo app
+
+A full demo lives in [`jupyter_renderer_react_demo/`](jupyter_renderer_react_demo)
+and exercises every feature (typed builders, JSON string, URL loading with events,
+custom styles, and live theme/prop toggles).
+
+```bash
+uv pip install -e .
+cd jupyter_renderer_react_demo
+uv run reflex run
+```
+
+## Building notebooks in Python
+
+```python
+from reflex_jupyter_renderer_react import (
+    Notebook, MarkdownCell, CodeCell,
+    stream_output, execute_result_output, error_output,
+)
+
+nb = Notebook(cells=[
+    MarkdownCell("# Report"),
+    CodeCell("print('hi')", execution_count=1, outputs=[stream_output("hi\n")]),
+    CodeCell("2 ** 10", execution_count=2,
+             outputs=[execute_result_output({"text/plain": "1024"}, execution_count=2)]),
+    CodeCell("1/0", execution_count=3,
+             outputs=[error_output("ZeroDivisionError", "division by zero")]),
+])
+data = nb.to_dict()
+```
+
+The data-model layer (`Notebook`, cells, output factories, `load_notebook`) imports
+**without Reflex installed**, so it is usable in plain scripts and unit tests.
+
+## Naming note
+
+The upstream project has some naming inconsistencies. This wrapper centralizes
+them in overridable constants and defaults to the **public, documented contract**:
+
+| Source | Name |
+|---|---|
+| Public README usage | `JupyterNotebookViewer` |
+| `src/index.ts` export | `JupiterNotebookViewer` (sic) |
+| `package.json` name | `@iomete/jupyter-renderer-react` (GitHub registry) |
+
+Defaults: `library = "jupyter-renderer-react"`, `tag = "JupyterNotebookViewer"`.
+To retarget the scoped package or the source-spelled tag:
+
+```python
+import reflex_jupyter_renderer_react.jupyter_renderer_react as j
+j.JupyterNotebookViewer.library = "@iomete/jupyter-renderer-react"
+j.JupyterNotebookViewer.tag = "JupiterNotebookViewer"
+```
+
+You can also pin a version via `LIBRARY_VERSION` in
+`custom_components/reflex_jupyter_renderer_react/jupyter_renderer_react.py`.
+
+## Development
+
+This project follows the Reflex **custom component** workflow and uses **`uv`**.
+
+```bash
+uv venv
+uv pip install -e ".[dev]"
+uv run pytest                 # run the tests
+
+# Publish (custom component flow)
+reflex component build        # -> dist/
+uv publish                    # or: twine upload dist/*
+reflex component share        # list in the Reflex gallery
+```
+
+See [`specs/`](specs) for the full Spec-Driven Design documentation: PRD,
+architecture, API, data-model schema, and the phased implementation plan & tasks.
+
+## Project structure
+
+```
+reflex-jupyter-renderer-react/
+├── custom_components/reflex_jupyter_renderer_react/
+│   ├── __init__.py
+│   ├── jupyter_renderer_react.py   # the Reflex component
+│   └── models.py                   # dependency-free notebook builders
+├── jupyter_renderer_react_demo/    # runnable demo app
+├── tests/                          # data-model + component contract tests
+├── specs/                          # SDD: prd / technical / api / data-model / plans
+├── pyproject.toml
+├── README.md · CHANGELOG.md · LICENSE
+```
+
+## License
+
+MIT © Ernesto Crespo. The upstream `jupyter-renderer-react` library is also MIT.

reflex_jupyter_renderer_react-0.1.0/README.md

@@ -0,0 +1,220 @@
+# reflex-jupyter-renderer-react
+
+[![PyPI version](https://img.shields.io/pypi/v/reflex-jupyter-renderer-react.svg)](https://pypi.org/project/reflex-jupyter-renderer-react/)
+[![Python versions](https://img.shields.io/pypi/pyversions/reflex-jupyter-renderer-react.svg)](https://pypi.org/project/reflex-jupyter-renderer-react/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ecrespo/reflex-jupyter-renderer-react/blob/main/LICENSE)
+[![GitHub](https://img.shields.io/badge/GitHub-ecrespo%2Freflex--jupyter--renderer--react-181717?logo=github)](https://github.com/ecrespo/reflex-jupyter-renderer-react)
+
+- **Source:** https://github.com/ecrespo/reflex-jupyter-renderer-react
+- **PyPI:** https://pypi.org/project/reflex-jupyter-renderer-react/
+- **Issues:** https://github.com/ecrespo/reflex-jupyter-renderer-react/issues
+- **Upstream React library:** https://github.com/iomete/jupyter-renderer-react
+
+A native [Reflex](https://reflex.dev/) component that wraps the
+[`jupyter-renderer-react`](https://github.com/iomete/jupyter-renderer-react) React
+library, so you can render **Jupyter notebooks (`.ipynb`)** in a Reflex app —
+with syntax highlighting, markdown, rich outputs, theming, collapsible cells and
+copy-to-clipboard — in **pure Python**. No HTML, no `iframe`, no hand-written
+JavaScript.
+
+```python
+import reflex as rx
+from reflex_jupyter_renderer_react import (
+    jupyter_notebook_viewer, Notebook, MarkdownCell, CodeCell, stream_output,
+)
+
+nb = Notebook(cells=[
+    MarkdownCell("# Hello, notebook"),
+    CodeCell("print('hi')", execution_count=1, outputs=[stream_output("hi\n")]),
+])
+
+def index() -> rx.Component:
+    return jupyter_notebook_viewer(notebook=nb.to_dict(), theme="dark")
+
+app = rx.App()
+app.add_page(index)
+```
+
+## Why a native component?
+
+| iframe / pre-rendered HTML | native component (this package) |
+|---|---|
+| Isolated from app state | Wired into Reflex state via events (`on_file_load`, `on_error`, …) |
+| Tied to static files/routes | Reusable, `pip install`-able |
+| Untyped JSON edited by hand | Typed Python builders for notebooks |
+| External hosting / manual embedding | npm dependency resolved by Reflex automatically |
+
+## Install
+
+```bash
+pip install reflex-jupyter-renderer-react
+# or, with uv:
+uv add reflex-jupyter-renderer-react
+# or, from this repo (editable):
+uv pip install -e .
+```
+
+Reflex installs the underlying npm package (`jupyter-renderer-react`) into the
+compiled frontend automatically on the first `reflex run`.
+
+## Usage
+
+### Three ways to supply a notebook
+
+```python
+from reflex_jupyter_renderer_react import (
+    jupyter_notebook_viewer, JupyterNotebookViewer, Notebook, MarkdownCell, CodeCell,
+    load_notebook,
+)
+
+# 1) Typed Python builders
+nb = Notebook(cells=[MarkdownCell("# Title"), CodeCell("1 + 1", execution_count=1)])
+jupyter_notebook_viewer(notebook=nb.to_dict())
+
+# 2) A raw JSON string
+jupyter_notebook_viewer(notebook='{"cells": [], "nbformat": 4, "nbformat_minor": 4}')
+# or: JupyterNotebookViewer.from_json(json_str)
+
+# 3) Load from a URL or from disk
+JupyterNotebookViewer.from_url("https://example.com/notebook.ipynb")
+jupyter_notebook_viewer(notebook=load_notebook("assets/demo-example.ipynb"))
+```
+
+### Props
+
+| Prop | Type | Default | Description |
+|---|---|---|---|
+| `notebook` | `dict \| str` | required | Parsed dict, JSON string, or `{"filePath": "..."}`. |
+| `theme` | `str \| dict` | `"light"` | `"light"`, `"dark"`, or a custom theme object. |
+| `show_cell_numbers` | `bool` | `True` | Show execution count for code cells. |
+| `show_outputs` | `bool` | `True` | Render cell outputs. |
+| `collapsible` | `bool` | `False` | Allow cells to collapse. |
+| `copyable` | `bool` | `True` | Copy button on code cells. |
+| `class_names` | `dict` | `{}` | Per-part class names (`classNames`). |
+| `styles` | `dict` | `{}` | Per-part inline styles (`styles`). |
+| `fetch_options` | `dict` | `{}` | `{"headers": {...}, "timeout": 10000}` for URL loading. |
+
+> Reflex converts `snake_case` props to `camelCase` automatically
+> (`show_cell_numbers` → `showCellNumbers`).
+
+### Events → Python
+
+```python
+class State(rx.State):
+    status: str = "idle"
+
+    @rx.event
+    def loaded(self, notebook: dict):
+        self.status = f"{len(notebook.get('cells', []))} cells loaded"
+
+    @rx.event
+    def failed(self, message: str):
+        self.status = f"error: {message}"
+
+JupyterNotebookViewer.from_url(
+    "https://example.com/notebook.ipynb",
+    fetch_options={"timeout": 10000},
+    on_file_load=State.loaded,
+    on_file_error=State.failed,
+)
+```
+
+| Event | Payload | Fires when |
+|---|---|---|
+| `on_file_load` | `notebook: dict` | A notebook is fetched from a `filePath`. |
+| `on_file_error` | `message: str` | File loading fails (network / 404 / timeout). |
+| `on_error` | `message: str` | Parsing / rendering fails. |
+
+## Demo app
+
+A full demo lives in [`jupyter_renderer_react_demo/`](jupyter_renderer_react_demo)
+and exercises every feature (typed builders, JSON string, URL loading with events,
+custom styles, and live theme/prop toggles).
+
+```bash
+uv pip install -e .
+cd jupyter_renderer_react_demo
+uv run reflex run
+```
+
+## Building notebooks in Python
+
+```python
+from reflex_jupyter_renderer_react import (
+    Notebook, MarkdownCell, CodeCell,
+    stream_output, execute_result_output, error_output,
+)
+
+nb = Notebook(cells=[
+    MarkdownCell("# Report"),
+    CodeCell("print('hi')", execution_count=1, outputs=[stream_output("hi\n")]),
+    CodeCell("2 ** 10", execution_count=2,
+             outputs=[execute_result_output({"text/plain": "1024"}, execution_count=2)]),
+    CodeCell("1/0", execution_count=3,
+             outputs=[error_output("ZeroDivisionError", "division by zero")]),
+])
+data = nb.to_dict()
+```
+
+The data-model layer (`Notebook`, cells, output factories, `load_notebook`) imports
+**without Reflex installed**, so it is usable in plain scripts and unit tests.
+
+## Naming note
+
+The upstream project has some naming inconsistencies. This wrapper centralizes
+them in overridable constants and defaults to the **public, documented contract**:
+
+| Source | Name |
+|---|---|
+| Public README usage | `JupyterNotebookViewer` |
+| `src/index.ts` export | `JupiterNotebookViewer` (sic) |
+| `package.json` name | `@iomete/jupyter-renderer-react` (GitHub registry) |
+
+Defaults: `library = "jupyter-renderer-react"`, `tag = "JupyterNotebookViewer"`.
+To retarget the scoped package or the source-spelled tag:
+
+```python
+import reflex_jupyter_renderer_react.jupyter_renderer_react as j
+j.JupyterNotebookViewer.library = "@iomete/jupyter-renderer-react"
+j.JupyterNotebookViewer.tag = "JupiterNotebookViewer"
+```
+
+You can also pin a version via `LIBRARY_VERSION` in
+`custom_components/reflex_jupyter_renderer_react/jupyter_renderer_react.py`.
+
+## Development
+
+This project follows the Reflex **custom component** workflow and uses **`uv`**.
+
+```bash
+uv venv
+uv pip install -e ".[dev]"
+uv run pytest                 # run the tests
+
+# Publish (custom component flow)
+reflex component build        # -> dist/
+uv publish                    # or: twine upload dist/*
+reflex component share        # list in the Reflex gallery
+```
+
+See [`specs/`](specs) for the full Spec-Driven Design documentation: PRD,
+architecture, API, data-model schema, and the phased implementation plan & tasks.
+
+## Project structure
+
+```
+reflex-jupyter-renderer-react/
+├── custom_components/reflex_jupyter_renderer_react/
+│   ├── __init__.py
+│   ├── jupyter_renderer_react.py   # the Reflex component
+│   └── models.py                   # dependency-free notebook builders
+├── jupyter_renderer_react_demo/    # runnable demo app
+├── tests/                          # data-model + component contract tests
+├── specs/                          # SDD: prd / technical / api / data-model / plans
+├── pyproject.toml
+├── README.md · CHANGELOG.md · LICENSE
+```
+
+## License
+
+MIT © Ernesto Crespo. The upstream `jupyter-renderer-react` library is also MIT.

reflex_jupyter_renderer_react-0.1.0/custom_components/reflex_jupyter_renderer_react/__init__.py

@@ -0,0 +1,79 @@
+"""reflex-jupyter-renderer-react.
+
+A native Reflex component that wraps the ``jupyter-renderer-react`` library so you
+can render Jupyter notebooks (``.ipynb``) in a Reflex app — with syntax
+highlighting, markdown, rich outputs, themes and collapsible cells — in pure
+Python.
+
+Typical use::
+
+    import reflex as rx
+    from reflex_jupyter_renderer_react import jupyter_notebook_viewer, Notebook, CodeCell, MarkdownCell
+
+    nb = Notebook(cells=[
+        MarkdownCell("# Hello"),
+        CodeCell("print('hi')", execution_count=1),
+    ])
+
+    def index() -> rx.Component:
+        return jupyter_notebook_viewer(notebook=nb.to_dict(), theme="dark")
+
+You can also load from a URL::
+
+    from reflex_jupyter_renderer_react import JupyterNotebookViewer
+
+    JupyterNotebookViewer.from_url("https://example.com/notebook.ipynb")
+"""
+
+from .models import (
+    CodeCell,
+    MarkdownCell,
+    Notebook,
+    Output,
+    RawCell,
+    display_data_output,
+    error_output,
+    execute_result_output,
+    load_notebook,
+    notebook_from_url,
+    stream_output,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    # Data model (importable without Reflex)
+    "Notebook",
+    "CodeCell",
+    "MarkdownCell",
+    "RawCell",
+    "Output",
+    "stream_output",
+    "display_data_output",
+    "execute_result_output",
+    "error_output",
+    "load_notebook",
+    "notebook_from_url",
+    # Component (requires Reflex)
+    "JupyterNotebookViewer",
+    "jupyter_notebook_viewer",
+    "LIBRARY_NAME",
+    "COMPONENT_TAG",
+    "PREDEFINED_THEMES",
+]
+
+# Keep the data-model layer importable even when Reflex is not installed.
+try:
+    from .jupyter_renderer_react import (
+        COMPONENT_TAG,
+        LIBRARY_NAME,
+        PREDEFINED_THEMES,
+        JupyterNotebookViewer,
+        jupyter_notebook_viewer,
+    )
+except ModuleNotFoundError:  # pragma: no cover - only without reflex installed
+    JupyterNotebookViewer = None  # type: ignore[assignment]
+    jupyter_notebook_viewer = None  # type: ignore[assignment]
+    LIBRARY_NAME = "jupyter-renderer-react"
+    COMPONENT_TAG = "JupyterNotebookViewer"
+    PREDEFINED_THEMES = ("light", "dark")