dash-capture 0.0.1__py3-none-any.whl

dash_capture/__init__.py

@@ -0,0 +1,45 @@
+# Copyright (c) Simon Niederberger.
+# Distributed under the terms of the MIT License.
+
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("dash-capture")
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+
+from dash_capture.capture import (
+    BatchBinding,
+    CaptureBinding,
+    FromPlotly,
+    capture_batch,
+    capture_binding,
+    capture_element,
+    capture_graph,
+)
+from dash_capture.strategies import (
+    CaptureStrategy,
+    canvas_strategy,
+    html2canvas_strategy,
+    plotly_strategy,
+)
+
+__all__ = [
+    # low-level
+    "BatchBinding",
+    "CaptureBinding",
+    "capture_batch",
+    "capture_binding",
+    # high-level (wizard)
+    "capture_graph",
+    "capture_element",
+    # strategies
+    "CaptureStrategy",
+    "plotly_strategy",
+    "html2canvas_strategy",
+    "canvas_strategy",
+    # hooks
+    "FromPlotly",
+]

dash_capture/_html2canvas.py

@@ -0,0 +1,45 @@
+"""Auto-include vendored html2canvas.min.js.
+
+When ``capture_element`` uses html2canvas_strategy, the JS library is
+automatically served via a Dash ``html.Script`` tag.  No CDN needed.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from dash import html
+
+_ASSETS_DIR = Path(__file__).parent / "assets"
+_LOADED = False
+
+
+def html2canvas_script() -> html.Script:
+    """Return a ``html.Script`` tag with the vendored html2canvas code.
+
+    The script is loaded inline to avoid needing an external CDN.
+    Call this once in your app layout::
+
+        app.layout = html.Div([
+            html2canvas_script(),
+            ...
+        ])
+
+    Or use ``capture_element()`` which includes it automatically.
+    """
+    js_path = _ASSETS_DIR / "html2canvas.min.js"
+    if not js_path.exists():
+        raise FileNotFoundError(
+            f"html2canvas.min.js not found at {js_path}. "
+            "The vendored file may be missing from the package installation."
+        )
+    return html.Script(js_path.read_text())
+
+
+def ensure_html2canvas(children: list) -> list:
+    """Prepend html2canvas script to children list if not already present."""
+    global _LOADED
+    if not _LOADED:
+        _LOADED = True
+        return [html2canvas_script(), *children]
+    return children

dash_capture/_ids.py

@@ -0,0 +1,25 @@
+# Copyright (c) Simon Niederberger.
+# Distributed under the terms of the MIT License.
+
+
+class _IdGenerator:
+    """Package-wide unique Dash component ID generator.
+
+    Generates IDs of the form ``_dcap_<prefix>_<n>`` where *n* is a
+    monotonically increasing integer, unique across the entire dash-capture
+    package.
+
+    Use the package-level singleton :data:`id_generator`.
+    """
+
+    def __init__(self) -> None:
+        self._counter = 0
+
+    def __call__(self, prefix: str = "") -> str:
+        self._counter += 1
+        return (
+            f"_dcap_{prefix}_{self._counter}" if prefix else f"_dcap_{self._counter}"
+        )
+
+
+id_generator = _IdGenerator()

dash_capture/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = None