marimo-utils 0.1.0__py3-none-any.whl

marimo_utils/__init__.py

@@ -0,0 +1,3 @@
+from marimo_utils.display import add_marimo_display, render_model
+
+__all__ = ["add_marimo_display", "render_model"]

marimo_utils/display.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import inspect
+import sys
+from collections.abc import Callable
+from pathlib import Path
+from typing import Any, TypeVar
+
+import marimo as mo
+from marimo._plugins.ui._core.ui_element import UIElement
+from pydantic import BaseModel
+
+TModel = TypeVar("TModel", bound=BaseModel)
+
+__all__ = [
+    "add_marimo_display",
+    "defining_path",
+    "relative_to_safe",
+    "render_model",
+    "resolve_repo_root",
+]
+
+
+def defining_path(obj: Any) -> Path | None:
+    """Best-effort path to the file that defined `obj`."""
+    src = inspect.getsourcefile(obj)
+    if not src:
+        try:
+            src = inspect.getfile(obj)
+        except TypeError:
+            src = None
+    if src:
+        return Path(src).resolve()
+    mod_name = getattr(obj, "__module__", None)
+    mod = sys.modules.get(mod_name) if mod_name else None
+    mod_file = getattr(mod, "__file__", None) if mod else None
+    return Path(mod_file).resolve() if mod_file else None
+
+
+def resolve_repo_root(model: BaseModel) -> Path:
+    if hasattr(model, "repo_root"):
+        repo_root = getattr(model, "repo_root")
+        if repo_root:
+            return Path(str(repo_root))
+    if hasattr(model, "paths"):
+        paths = getattr(model, "paths")
+        if paths and hasattr(paths, "repo_root"):
+            repo_root = getattr(paths, "repo_root")
+            if repo_root:
+                return Path(str(repo_root))
+    return Path(__file__).resolve().parent.parent.parent
+
+
+def relative_to_safe(path: Path, base: Path) -> Path:
+    try:
+        return path.relative_to(base)
+    except ValueError:
+        return path
+
+
+def render_model(
+    model: BaseModel, class_path: Path | str | None
+) -> UIElement | mo.Html:
+    class_path = class_path or "Unknown"
+    rel_path = (
+        class_path
+        if isinstance(class_path, str)
+        else relative_to_safe(class_path, resolve_repo_root(model))
+    )
+    rel_path_str = f"<small>`{rel_path}`</small>"
+    return mo.vstack(
+        [
+            mo.md(f"**{model.__class__.__name__}** | {rel_path_str}"),
+            model.model_dump(),
+        ]
+    )
+
+
+def add_marimo_display() -> Callable[[type[TModel]], type[TModel]]:
+    """Add a `_display_` method to Pydantic models for marimo rendering."""
+
+    def decorator(cls: type[TModel]) -> type[TModel]:
+        class_path = defining_path(cls)
+
+        def _display_(self: BaseModel) -> UIElement | mo.Html:
+            return render_model(self, class_path)
+
+        setattr(cls, "_display_", _display_)
+        return cls
+
+    return decorator

marimo_utils-0.1.0.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: marimo-utils
+Version: 0.1.0
+Summary: Utilities for working with marimo notebooks, including Pydantic model display
+Project-URL: Homepage, https://github.com/drothermel/marimo_utils
+Project-URL: Repository, https://github.com/drothermel/marimo_utils
+Author-email: Danielle Rothermel <danielle.rothermel@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: display,marimo,notebooks,pydantic
+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.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: marimo>=0.19.4
+Requires-Dist: pydantic>=2.12.5
+Description-Content-Type: text/markdown
+
+# marimo-utils
+
+Utilities for working with marimo notebooks.
+
+## Installation
+
+```bash
+pip install marimo-utils
+```
+
+## Usage
+
+### `@add_marimo_display()` decorator
+
+Adds a `_display_` method to Pydantic models for rich rendering in marimo notebooks.
+
+```python
+from pydantic import BaseModel
+from marimo_utils import add_marimo_display
+
+@add_marimo_display()
+class MyConfig(BaseModel):
+    name: str
+    value: int
+```
+
+When a `MyConfig` instance is the last expression in a marimo cell, it renders with the class name, source file path, and all field values.

marimo_utils-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+marimo_utils/__init__.py,sha256=rnYqA0S2abZS8J9RyfZ-xB1-7O1fCbUtVJZeJwQF7LE,116
+marimo_utils/display.py,sha256=c6Bzb2fguw2P77coLpK7dGYerirROS5MGkzVDTC-8ko,2550
+marimo_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+marimo_utils-0.1.0.dist-info/METADATA,sha256=h5ikSU_rZHhN9dM2C5x-7BCFRMc-naJ6phNwDs55iQI,1430
+marimo_utils-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+marimo_utils-0.1.0.dist-info/licenses/LICENSE,sha256=6tUm1Q55M1UBMbbawzFlF0-DgCazM1BELo_5-RXA1K4,1075
+marimo_utils-0.1.0.dist-info/RECORD,,

marimo_utils-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

marimo_utils-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Danielle Rothermel
+
+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.