plotly-print 0.1.0__py3-none-any.whl

plotly_print/plotly_hook.py

@@ -0,0 +1,95 @@
+from __future__ import annotations
+
+from typing import Any, BinaryIO
+
+import plotly_print.core as core
+
+_ORIGINAL_TO_IMAGE = None
+_ORIGINAL_WRITE_IMAGE = None
+_IS_PATCHED = False
+
+
+def _patched_to_image(
+    fig: Any,
+    format: str | None = None,
+    width: int | None = None,
+    height: int | None = None,
+    scale: float | None = None,
+    validate: bool = True,
+    **kwargs: Any,
+) -> bytes:
+    return core.to_image(
+        fig,
+        format=format or 'png',
+        width=width,
+        height=height,
+        scale=scale or 1.0,
+    )
+
+
+def _patched_write_image(
+    fig: Any,
+    file: str | BinaryIO,
+    format: str | None = None,
+    scale: float | None = None,
+    width: int | None = None,
+    height: int | None = None,
+    validate: bool = True,
+    **kwargs: Any,
+) -> None:
+    core.write_image(
+        fig,
+        file=file,
+        format=format,
+        scale=scale or 1.0,
+        width=width,
+        height=height,
+    )
+
+
+def register() -> None:
+    global _ORIGINAL_TO_IMAGE, _ORIGINAL_WRITE_IMAGE, _IS_PATCHED
+    if _IS_PATCHED:
+        return
+
+    try:
+        import plotly.graph_objects as go
+        import plotly.io as pio
+
+        _ORIGINAL_TO_IMAGE = pio.to_image
+        _ORIGINAL_WRITE_IMAGE = pio.write_image
+
+        pio.to_image = _patched_to_image
+        pio.write_image = _patched_write_image
+        go.Figure.to_image = _patched_to_image
+        go.Figure.write_image = _patched_write_image
+
+        _IS_PATCHED = True
+    except ImportError:
+        pass
+
+
+def unregister() -> None:
+    global _ORIGINAL_TO_IMAGE, _ORIGINAL_WRITE_IMAGE, _IS_PATCHED
+    if not _IS_PATCHED:
+        return
+
+    try:
+        import plotly.graph_objects as go
+        import plotly.io as pio
+
+        if _ORIGINAL_TO_IMAGE:
+            pio.to_image = _ORIGINAL_TO_IMAGE
+            go.Figure.to_image = _ORIGINAL_TO_IMAGE
+
+        if _ORIGINAL_WRITE_IMAGE:
+            pio.write_image = _ORIGINAL_WRITE_IMAGE
+            go.Figure.write_image = _ORIGINAL_WRITE_IMAGE
+
+        _IS_PATCHED = False
+    except ImportError:
+        pass
+
+
+patch_plotly = register
+unpatch_plotly = unregister

plotly_print/raster.py

@@ -0,0 +1,186 @@
+from __future__ import annotations
+
+import io
+import re
+from pathlib import Path
+from typing import BinaryIO
+
+import resvg_py
+from PIL import Image
+
+SYSTEM_FONT_DIRS = [
+    '/System/Library/Fonts/Supplemental',
+    '/Library/Fonts',
+    '/System/Library/Fonts',
+    '/usr/share/fonts',
+    '/usr/local/share/fonts',
+]
+EXISTING_FONT_DIRS = [d for d in SYSTEM_FONT_DIRS if Path(d).is_dir()]
+
+COMMON_FONT_NAMES = [
+    'verdana',
+    'arial',
+    'tahoma',
+    'trebuchet ms',
+    'helvetica',
+    'times new roman',
+    'courier new',
+    'georgia',
+]
+
+_SVG_ROOT_RE = re.compile(r'<svg\b[^>]*>', re.IGNORECASE)
+_ATTR_RE = re.compile(r'([^\s=]+)\s*=\s*("([^"]*)"|\'([^\']*)\')')
+_LENGTH_RE = re.compile(r'^([+-]?(?:\d+\.?\d*|\.\d+)(?:[eE][+-]?\d+)?)\s*[a-z%]*$', re.IGNORECASE)
+
+
+def _normalize_svg_fonts(svg: str) -> str:
+    def _cap(m: re.Match[str]) -> str:
+        val = m.group(0)
+        for name in COMMON_FONT_NAMES:
+            val = re.sub(r'\b' + re.escape(name) + r'\b', name.title(), val, flags=re.IGNORECASE)
+        return val
+
+    return re.sub(r'font-family:\s*[^;\"}]+', _cap, svg)
+
+
+def _parse_length(value: str | None) -> float | None:
+    if value is None:
+        return None
+    m = _LENGTH_RE.match(value.strip())
+    if not m:
+        return None
+    return float(m.group(1))
+
+
+def _parse_svg_layout_size(svg: str) -> tuple[float, float]:
+    root = _SVG_ROOT_RE.search(svg)
+    if not root:
+        raise ValueError('SVG root element not found')
+
+    attrs = {
+        m.group(1).lower(): (m.group(3) if m.group(3) is not None else m.group(4))
+        for m in _ATTR_RE.finditer(root.group(0))
+    }
+
+    width = _parse_length(attrs.get('width'))
+    height = _parse_length(attrs.get('height'))
+
+    if (width is None or height is None) and 'viewbox' in attrs:
+        parts = attrs['viewbox'].replace(',', ' ').split()
+        if len(parts) == 4:
+            if width is None:
+                width = float(parts[2])
+            if height is None:
+                height = float(parts[3])
+
+    if width is None or height is None:
+        raise ValueError('Could not determine SVG layout width/height')
+    return width, height
+
+
+def _prepare_svg_for_raster(
+    svg: str,
+    width: int | None = None,
+    height: int | None = None,
+    scale: float = 1.0,
+) -> str:
+    layout_w, layout_h = _parse_svg_layout_size(svg)
+    if width is not None:
+        layout_w = float(width)
+    if height is not None:
+        layout_h = float(height)
+
+    out_w = max(1, int(round(layout_w * scale)))
+    out_h = max(1, int(round(layout_h * scale)))
+
+    root = _SVG_ROOT_RE.search(svg)
+    if not root:
+        raise ValueError('SVG root element not found')
+
+    tag = root.group(0)
+    existing = {m.group(1).lower() for m in _ATTR_RE.finditer(tag)}
+
+    def _set_attr(tag_str: str, name: str, value: str) -> str:
+        pattern = rf'({re.escape(name)}\s*=\s*)("([^"]*)"|\'([^\']*)\')'
+        if re.search(pattern, tag_str, flags=re.IGNORECASE):
+            return re.sub(pattern, rf'\1"{value}"', tag_str, count=1, flags=re.IGNORECASE)
+        return re.sub(r'\s*>$', f' {name}="{value}">', tag_str, count=1)
+
+    new_tag = tag
+    new_tag = _set_attr(new_tag, 'width', str(out_w))
+    new_tag = _set_attr(new_tag, 'height', str(out_h))
+    if 'viewbox' not in existing:
+        vb_w = int(layout_w) if layout_w == int(layout_w) else layout_w
+        vb_h = int(layout_h) if layout_h == int(layout_h) else layout_h
+        new_tag = _set_attr(new_tag, 'viewBox', f'0 0 {vb_w} {vb_h}')
+
+    return svg[: root.start()] + new_tag + svg[root.end() :]
+
+
+def svg_to_png(
+    svg: str,
+    width: int | None = None,
+    height: int | None = None,
+    scale: float = 1.0,
+) -> bytes:
+    normalized_svg = _normalize_svg_fonts(svg)
+    prepared = _prepare_svg_for_raster(normalized_svg, width=width, height=height, scale=scale)
+    if EXISTING_FONT_DIRS:
+        return resvg_py.svg_to_bytes(prepared, font_dirs=EXISTING_FONT_DIRS)
+    return resvg_py.svg_to_bytes(prepared)
+
+
+def svg_to_jpeg(
+    svg: str,
+    width: int | None = None,
+    height: int | None = None,
+    scale: float = 1.0,
+    quality: int = 90,
+) -> bytes:
+    png_bytes = svg_to_png(svg, width=width, height=height, scale=scale)
+    img = Image.open(io.BytesIO(png_bytes))
+    if img.mode in ('RGBA', 'LA', 'P'):
+        bg = Image.new('RGB', img.size, (255, 255, 255))
+        bg.paste(img, mask=img.split()[-1] if img.mode == 'RGBA' else None)
+        img = bg
+    buf = io.BytesIO()
+    img.save(buf, format='JPEG', quality=quality)
+    return buf.getvalue()
+
+
+def svg_to_webp(
+    svg: str,
+    width: int | None = None,
+    height: int | None = None,
+    scale: float = 1.0,
+    quality: int = 90,
+) -> bytes:
+    png_bytes = svg_to_png(svg, width=width, height=height, scale=scale)
+    img = Image.open(io.BytesIO(png_bytes))
+    buf = io.BytesIO()
+    img.save(buf, format='WEBP', quality=quality)
+    return buf.getvalue()
+
+
+def write_raster(
+    svg: str,
+    target: str | BinaryIO,
+    format: str = 'png',
+    width: int | None = None,
+    height: int | None = None,
+    scale: float = 1.0,
+) -> None:
+    fmt = format.lower().strip()
+    if fmt == 'png':
+        data = svg_to_png(svg, width=width, height=height, scale=scale)
+    elif fmt in ('jpg', 'jpeg'):
+        data = svg_to_jpeg(svg, width=width, height=height, scale=scale)
+    elif fmt == 'webp':
+        data = svg_to_webp(svg, width=width, height=height, scale=scale)
+    else:
+        raise ValueError(f"Unsupported raster format: {format}. Supported: 'png', 'jpeg', 'webp'")
+
+    if isinstance(target, str):
+        Path(target).write_bytes(data)
+    else:
+        target.write(data)

plotly_print-0.1.0.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.5
+Name: plotly-print
+Version: 0.1.0
+Summary: Lightweight, browser-less static image exporter for Plotly
+Project-URL: Homepage, https://github.com/roman-kaczanowski/plotly-print
+Project-URL: Repository, https://github.com/roman-kaczanowski/plotly-print
+Project-URL: Issues, https://github.com/roman-kaczanowski/plotly-print/issues
+Author-email: Roman Kaczanowski <roman.kaczanowski.pl@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Keywords: export,headless,kaleido,plotly,png,svg,visualization
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.12
+Requires-Dist: pillow>=9.0.0
+Requires-Dist: plotly>=5.0.0
+Requires-Dist: quickjs>=1.19.0
+Requires-Dist: resvg-py>=0.4.0
+Description-Content-Type: text/markdown
+
+# plotly-print
+
+[![CI](https://img.shields.io/github/actions/workflow/status/roman-kaczanowski/plotly-print/quality-checks.yml?branch=main&style=flat-square&label=CI)](https://github.com/roman-kaczanowski/plotly-print/actions/workflows/quality-checks.yml) [![PyPI](https://img.shields.io/pypi/v/plotly-print?style=flat-square)](https://pypi.org/project/plotly-print/) [![Python](https://img.shields.io/badge/python-3.12%2B-3776AB?style=flat-square&logo=python&logoColor=white)](https://docs.python.org/3/) [![License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](LICENSE)
+
+Lightweight, browser-less static image exporter for Plotly. No Chrome, Chromium, or Playwright. Figures are rendered with an embedded QuickJS runtime, Pillow font metrics, and `resvg-py` for raster output.
+
+Works offline: an official plotly.js cartesian partial is bundled (see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)).
+
+## Install
+
+```bash
+pip install plotly-print
+```
+
+## Quickstart
+
+```python
+import plotly.express as px
+import plotly_print
+
+fig = px.scatter(x=[1, 2, 3, 4], y=[10, 11, 12, 13], title='Sales Growth')
+
+svg = plotly_print.to_svg(fig)
+png = plotly_print.to_image(fig, format='png', scale=2)
+plotly_print.write_image(fig, 'chart.png')
+```
+
+Patch Plotly's `to_image` / `write_image` to use plotly-print:
+
+```python
+import plotly_print
+
+plotly_print.register()
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and releases.
+
+## Attribution
+
+plotly-print is an independent project derived from [Mirage](https://github.com/ProfLear/mirage) by Benjamin Lear (MIT). Bundled plotly.js is copyright Plotly, Inc. (MIT); see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

plotly_print-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+plotly_print/__init__.py,sha256=I1cd1rMBO4T-iXNZHSvXk56feaRVkQZmGD-revYJNX0,472
+plotly_print/core.py,sha256=o7_nxKGJA6pyfst1hnNrcP9OMcpa9oDA0AdEA-LGN3I,2289
+plotly_print/engine.py,sha256=sJuvT9liDvSUWYdyscABr_YqZnJiJh23QpQj3nJ_iC0,6355
+plotly_print/fonts.py,sha256=2EoV2tPeHNxwTtJk4oQsbESwTtnRCmqbfB2qnB5jNsE,5355
+plotly_print/plotly_hook.py,sha256=RGwoGJLH0QOmTEQUtmuE46B1rlDueKCG-vuqwbf-0iI,2121
+plotly_print/raster.py,sha256=K2MfOzjUJrSXwEqAdbZ2pt9jSb_6oSJB74ku3v0GG4c,5642
+plotly_print/js/micro_dom.js,sha256=rcN8N0BQIYukGhTPMsdIzzmXOothJiZQHx5sqTqrhcQ,45471
+plotly_print/js/plotly-cartesian.min.js,sha256=eVQhUIVaUsVnJg4xNwldvit0Tm1wKlyr5n2iRpQvuno,1500041
+plotly_print-0.1.0.dist-info/METADATA,sha256=Yvrn5sAt0Hnhok5z9qcwz2GYkKBLRGYDAZ3Nbz3XFx0,2813
+plotly_print-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+plotly_print-0.1.0.dist-info/licenses/LICENSE,sha256=kKBHCvoTsEA_8Q6ya-9Dh6KkkvdPVcECv16n2V1PtmY,1107
+plotly_print-0.1.0.dist-info/licenses/THIRD_PARTY_NOTICES.md,sha256=XvdnfmHBOHRcuape6KTVJ45osBjtg4tp5oblhNHst1I,1598
+plotly_print-0.1.0.dist-info/RECORD,,

plotly_print-0.1.0.dist-info/WHEEL

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

plotly_print-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Benjamin Lear
+Copyright (c) 2026 Roman Kaczanowski
+
+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.

plotly_print-0.1.0.dist-info/licenses/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,40 @@
+# Third-party notices
+
+## plotly.js
+
+File: `src/plotly_print/js/plotly-cartesian.min.js`
+
+Official plotly.js **cartesian** partial (minified) v4.1.1, redistributed for offline /
+isolated environments. The full `plotly.min.js` shipped with the `plotly` Python package
+does not load in the embedded QuickJS runtime, so this smaller official partial is bundled
+instead.
+
+Copyright 2012-2026, Plotly, Inc.
+All rights reserved.
+Licensed under the MIT license.
+
+```text
+The MIT License (MIT)
+
+Copyright (c) 2014-2026 Plotly, Inc
+
+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.
+```
+
+Upstream: https://github.com/plotly/plotly.js