PyPI - plotly-print - Versions diffs - 0.1.0__tar.gz → 0.2.2__tar.gz - Mend

plotly-print 0.1.0tar.gz → 0.2.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (84) hide show

{plotly_print-0.1.0 → plotly_print-0.2.2}/.cursor/rules/artifacts.mdc RENAMED Viewed

@@ -7,9 +7,8 @@ alwaysApply: true
 The repo root `.artifacts/` directory is **gitignored**. Use it for:
-- Benchmark output (`poe benchmark` writes to `.artifacts/benchmark/`)
 - LLM research notes, comparison reports, scratch exports, and other **temporary local artifacts**
 Do not commit files under `.artifacts/`. Nothing there is shipped on PyPI or in the wheel.
-When generating reports or large binary outputs for the user to review, prefer paths under `.artifacts/` unless they ask for another location.
+When generating research or large binary outputs for the user to review (outside the benchmark), prefer paths under `.artifacts/` unless they ask for another location.

{plotly_print-0.1.0 → plotly_print-0.2.2}/.cursor/rules/global.mdc RENAMED Viewed

@@ -1,11 +1,13 @@
 ---
-description: Coding standards for every project generated from cookiecutter-python-seed
+description: Coding standards for plotly-print (Python package + QuickJS micro-DOM)
 alwaysApply: true
 ---
-# Generated project standards
+# Project standards
-This is a Python project generated from cookiecutter-python-seed. Treat `pyproject.toml` as the source of truth for toolchain, Python version, and dependencies. Minimum Python version is 3.12. Use uv to lock, sync, build, and bump versions.
+plotly-print is a Python package (cookiecutter-python-seed layout) plus first-party QuickJS JavaScript under `src/plotly_print/js/` (micro-DOM for static Plotly rendering). Treat `pyproject.toml` as the source of truth for toolchain, Python version, and dependencies. Minimum Python version is 3.12. Use uv to lock, sync, build, and bump versions.
+JS-specific conventions: `.cursor/rules/javascript.mdc` (applies under `src/plotly_print/js/`).
 You are a lazy senior developer. Lazy means efficient, not careless. The best code is the code never written.
@@ -26,9 +28,10 @@ Bug fix = root cause, not symptom. Grep every caller of the function you touch a
 - Match existing layout: `src/` for packages, `tests/` for tests, application entry points as already configured.
 - Do not add a dependency unless it is declared in `pyproject.toml` (or the project's lockfile). Prefer stdlib over a new package.
-- Style is enforced by Ruff. Follow `pyproject.toml`; the points below are the ones to apply consistently even when Ruff cannot.
+- Python style is enforced by Ruff. Follow `pyproject.toml`; the points below are the ones to apply consistently even when Ruff cannot.
 - After editing Python files, run `poe format`.
 - After editing Markdown files, run `poe format_docs`.
+- There is no JS formatter/linter task; match `micro_dom.js` style. Do not hand-edit vendored Plotly bundles.
 ## Comments and docs
@@ -38,15 +41,20 @@ Bug fix = root cause, not symptom. Grep every caller of the function you touch a
 ## Language
-- Type-hint every function and method. Do not nest annotations so deeply that they hurt readability.
+Shared (Python and JS):
+- ASCII only in identifiers, comments, and docs. No emojis. Non-ASCII letters are allowed only when the content is actually in another language (e.g. Polish, Russian).
 - No unnecessary imports.
+Python:
+- Type-hint every function and method. Do not nest annotations so deeply that they hurt readability.
 - Use f-strings for all string formatting.
 - Avoid unnecessary `Path` wrappers; join with `/` on `Path` objects.
-- ASCII only in identifiers, comments, and docs. No emojis. Non-ASCII letters are allowed only when the content is actually in another language (e.g. Polish, Russian).
 ## Quality
-- Use `poe format` / `poe format_docs` instead of hand-formatting style.
+- Use `poe format` / `poe format_docs` instead of hand-formatting style (Python/Markdown).
 - Deletion over addition. Boring over clever. Fewest files possible. Shortest working diff wins, after you understand the problem.
 - No abstractions, boilerplate, or dependencies that weren't requested.
 - Question complex requests: "Do you actually need X, or does Y cover it?"

plotly_print-0.2.2/.cursor/rules/javascript.mdc ADDED Viewed

@@ -0,0 +1,33 @@
+---
+description: QuickJS micro-DOM and first-party JS (not the vendored Plotly bundle)
+globs: "src/plotly_print/js/**/*.js"
+alwaysApply: false
+---
+# JavaScript (QuickJS)
+First-party runtime JS lives under `src/plotly_print/js/`. It runs inside QuickJS via `plotly_print.engine`, not in Node or a browser.
+## Do not edit
+- `plotly_comprehensive_2d.js` and any other vendored Plotly/plotly.js bundle. Treat as opaque third-party input.
+- Only change first-party files such as `micro_dom.js`.
+## Style (match `micro_dom.js`)
+- IIFE + `'use strict'`. No ES modules, `import`/`export`, or build step.
+- Prefer ES5 that QuickJS already accepts here: `var`, `function`, prototypes. Use newer features only when the file already does (e.g. `Proxy` with a fallback).
+- 4-space indent. ASCII only in identifiers and comments (no emojis, arrows, smart dashes).
+- No TypeScript. No Prettier/ESLint in this repo; match existing formatting by eye.
+- Same comment rules as the rest of the project: why not what; `ponytail:` for deliberate ceilings.
+## DOM / SVG stubs
+- Implement the minimum Plotly/d3 actually call. Prefer attribute-backed getters (e.g. `transform` from `getAttribute('transform')`) over inventing full SVG DOM types.
+- When adding a browser API stub, grep the Plotly bundle for the call shape (`baseVal.consolidate`, etc.) and return what that path reads.
+- Keep geometry helpers (`parseTransform`, path flatten, bbox) shared; do not duplicate matrix math per method.
+## Tests
+- JS has no separate test runner. Cover behavior from Python with `quickjs.Context` loading `micro_dom.js` (see `tests/test_svg_*.py`), or via `plotly_print.to_svg` / figure fixtures when the bug is Plotly-facing.
+- After non-trivial micro-DOM changes, run the relevant `tests/test_svg_*.py` (or the smallest Plotly render check that would fail).

{plotly_print-0.1.0 → plotly_print-0.2.2}/AGENTS.md RENAMED Viewed

@@ -1,6 +1,6 @@
 # Agent instructions
-This project was generated from **cookiecutter-python-seed**.
+This project was generated from **cookiecutter-python-seed**, with first-party QuickJS JavaScript for Plotly static rendering.
 ## Tooling
@@ -10,5 +10,6 @@ This project was generated from **cookiecutter-python-seed**.
 ## Standards
 - Always-on: `.cursor/rules/global.mdc`
+- JavaScript (`src/plotly_print/js/`): `.cursor/rules/javascript.mdc`
 - Markdown (`.md` files): `.cursor/rules/markdown.mdc`
 - Local scratch output: `.cursor/rules/artifacts.mdc`

{plotly_print-0.1.0 → plotly_print-0.2.2}/CONTRIBUTING.md RENAMED Viewed

@@ -22,15 +22,15 @@ poe test
 ## Kaleido visual benchmark
-Compare plotly-print output to Kaleido side by side (not part of the PyPI wheel). Kaleido is in the `test` dependency group and is installed by `poe install` / `uv sync`.
+Compare plotly-print to Kaleido (dev-only; not in the PyPI wheel). Kaleido is in the `test` dependency group and is installed by `poe install` / `uv sync`.
 ```shell
-poe benchmark_quick
+poe benchmark
 ```
-Full gallery (all chart fixtures): `poe benchmark`.
+Writes side-by-side PNGs (Kaleido / Chromium left, plotly-print / QuickJS right) and `benchmark_summary.json` under `assets/benchmarks/`, and refreshes the speed/visual sections in `README.md` (image links use absolute `raw.githubusercontent.com` URLs). Commit those assets with the README when timings or visuals change.
-Outputs are written to `.artifacts/benchmark/` (`report.md`, PNGs, `benchmark_summary.json`).
+`poe test` includes a Kaleido mean-pixel-diff check for **every** chart fixture in `benchmark/cases.py` (skipped if Kaleido is not installed).
 ## Release

plotly_print-0.2.2/PKG-INFO ADDED Viewed

@@ -0,0 +1,261 @@
+Metadata-Version: 2.5
+Name: plotly-print
+Version: 0.2.2
+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)
+Export Plotly figures to SVG, PNG, JPEG, or WebP without launching Chrome.
+plotly-print runs a bundled Plotly.js 2D build in QuickJS, then uses `resvg-py` for raster output. It works offline, has no browser process to install or manage, and can replace Plotly's image-export methods with one call.
+- Browser-free: no Chrome, Chromium, or Playwright.
+- Fast: avoids browser startup; see the measured [benchmarks](#benchmarks).
+- Familiar: use the direct API or patch Plotly's existing `to_image` and `write_image` methods.
+[Install](#installation) | [Direct API](#direct-api) | [Plotly integration](#plotly-integration) | [Benchmarks](#benchmarks)
+## Installation
+```bash
+pip install plotly-print
+```
+Requires Python 3.12 or newer.
+## Direct API
+```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')
+```
+`to_image` returns bytes. `write_image` writes to a path or binary file object. Supported formats are SVG, PNG, JPEG, and WebP.
+## Plotly integration
+Patch Plotly's existing image-export methods:
+```python
+import plotly_print
+plotly_print.register()
+```
+After registration, existing calls such as `fig.write_image("chart.png")` use plotly-print. Call `plotly_print.unregister()` to restore Plotly's original methods.
+plotly-print targets 2D static charts. The bundled Plotly.js build and its licenses are documented in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+<!-- BENCHMARK-START -->
+## Benchmarks
+On this run, plotly-print exported all 30 chart types **12x to 33x faster** than Kaleido.
+These are mean per-image PNG export times after both engines were warmed up. Timings are machine-specific; use the side-by-side images below to evaluate rendering differences.
+See the [raw results](assets/benchmarks/benchmark_summary.json) or [run the benchmark locally](CONTRIBUTING.md#kaleido-visual-benchmark).
+| Category                 | Chart Type                                |  Kaleido  | plotly-print |  Speedup  |
+| :----------------------- | :---------------------------------------- | :-------: | :----------: | :-------: |
+| **Core Cartesian**       | Scatter & Line Chart                      | 1668.5 ms | **88.2 ms**  | **18.9x** |
+| **Core Cartesian**       | Grouped Bar Chart                         | 1758.1 ms | **81.3 ms**  | **21.6x** |
+| **Core Cartesian**       | Donut / Pie Chart                         | 1628.6 ms | **73.6 ms**  | **22.1x** |
+| **Core Cartesian**       | Box Plot                                  | 1748.2 ms | **77.1 ms**  | **22.7x** |
+| **Core Cartesian**       | Violin Plot                               | 1623.8 ms | **84.1 ms**  | **19.3x** |
+| **Core Cartesian**       | Frequency Histogram                       | 1878.0 ms | **62.7 ms**  | **30.0x** |
+| **Core Cartesian**       | 2D Density Histogram                      | 1949.4 ms | **98.8 ms**  | **19.7x** |
+| **Core Cartesian**       | 2D Contour Plot                           | 1604.9 ms | **118.7 ms** | **13.5x** |
+| **Core Cartesian**       | Performance Heatmap                       | 1832.4 ms | **87.3 ms**  | **21.0x** |
+| **Core Cartesian**       | Ternary Phase Diagram                     | 1724.9 ms | **84.9 ms**  | **20.3x** |
+| **Financial & Business** | Candlestick Stock Chart                   | 1741.1 ms | **140.5 ms** | **12.4x** |
+| **Financial & Business** | OHLC Financial Chart                      | 1670.0 ms | **131.3 ms** | **12.7x** |
+| **Financial & Business** | Waterfall Profit & Loss                   | 1793.0 ms | **64.7 ms**  | **27.7x** |
+| **Financial & Business** | Sales Conversion Funnel                   | 1629.9 ms | **91.1 ms**  | **17.9x** |
+| **Financial & Business** | Funnel Area Analysis                      | 1694.0 ms | **61.7 ms**  | **27.5x** |
+| **Financial & Business** | KPI Performance Indicator                 | 1634.1 ms | **57.2 ms**  | **28.6x** |
+| **Hierarchical**         | Market Cap Treemap                        | 1625.4 ms | **52.6 ms**  | **30.9x** |
+| **Hierarchical**         | Global Sunburst Hierarchy                 | 1723.9 ms | **61.8 ms**  | **27.9x** |
+| **Hierarchical**         | Icicle Partition Chart                    | 1594.7 ms | **50.2 ms**  | **31.7x** |
+| **Radial & Polar**       | Radar Performance Comparison              | 2481.9 ms | **96.5 ms**  | **25.7x** |
+| **Radial & Polar**       | Polar Wind Rose                           | 1826.6 ms | **77.5 ms**  | **23.6x** |
+| **Specialized Diagrams** | Energy Flow Sankey Diagram                | 1708.4 ms | **51.7 ms**  | **33.1x** |
+| **Specialized Diagrams** | Parallel Categories Diagram               | 1620.2 ms | **57.0 ms**  | **28.4x** |
+| **Specialized Diagrams** | Formatted Data Table                      | 1766.4 ms | **69.9 ms**  | **25.3x** |
+| **Specialized Diagrams** | Carpet Coordinate Plot                    | 1792.2 ms | **86.1 ms**  | **20.8x** |
+| **Layout edge cases**    | Bar chart with X labels at 45 deg         | 1673.2 ms | **89.0 ms**  | **18.8x** |
+| **Layout edge cases**    | Bar chart with X labels at 90 deg         | 1883.9 ms | **87.7 ms**  | **21.5x** |
+| **Layout edge cases**    | Annotation arrowheads (incl. circle)      | 1661.6 ms | **82.4 ms**  | **20.2x** |
+| **Layout edge cases**    | Long annotation arrows (dasharray length) | 1719.1 ms | **79.7 ms**  | **21.6x** |
+| **Layout edge cases**    | Table cells with HTML markup and entities | 1692.5 ms | **74.8 ms**  | **22.6x** |
+## Visual comparisons
+Side-by-side PNGs (Kaleido left, plotly-print right):
+### Core Cartesian
+#### Scatter & Line Chart (plotly-print: 88.2ms | Kaleido: 1668.5ms)
+![Scatter & Line Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_scatter_line.png)
+#### Grouped Bar Chart (plotly-print: 81.3ms | Kaleido: 1758.1ms)
+![Grouped Bar Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_bar.png)
+#### Donut / Pie Chart (plotly-print: 73.6ms | Kaleido: 1628.6ms)
+![Donut / Pie Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_pie.png)
+#### Box Plot (plotly-print: 77.1ms | Kaleido: 1748.2ms)
+![Box Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_box.png)
+#### Violin Plot (plotly-print: 84.1ms | Kaleido: 1623.8ms)
+![Violin Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_violin.png)
+#### Frequency Histogram (plotly-print: 62.7ms | Kaleido: 1878.0ms)
+![Frequency Histogram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_histogram.png)
+#### 2D Density Histogram (plotly-print: 98.8ms | Kaleido: 1949.4ms)
+![2D Density Histogram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_histogram2d.png)
+#### 2D Contour Plot (plotly-print: 118.7ms | Kaleido: 1604.9ms)
+![2D Contour Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_contour.png)
+#### Performance Heatmap (plotly-print: 87.3ms | Kaleido: 1832.4ms)
+![Performance Heatmap](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_heatmap.png)
+#### Ternary Phase Diagram (plotly-print: 84.9ms | Kaleido: 1724.9ms)
+![Ternary Phase Diagram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_scatterternary.png)
+### Financial & Business
+#### Candlestick Stock Chart (plotly-print: 140.5ms | Kaleido: 1741.1ms)
+![Candlestick Stock Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_candlestick.png)
+#### OHLC Financial Chart (plotly-print: 131.3ms | Kaleido: 1670.0ms)
+![OHLC Financial Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_ohlc.png)
+#### Waterfall Profit & Loss (plotly-print: 64.7ms | Kaleido: 1793.0ms)
+![Waterfall Profit & Loss](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_waterfall.png)
+#### Sales Conversion Funnel (plotly-print: 91.1ms | Kaleido: 1629.9ms)
+![Sales Conversion Funnel](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_funnel.png)
+#### Funnel Area Analysis (plotly-print: 61.7ms | Kaleido: 1694.0ms)
+![Funnel Area Analysis](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_funnelarea.png)
+#### KPI Performance Indicator (plotly-print: 57.2ms | Kaleido: 1634.1ms)
+![KPI Performance Indicator](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_indicator.png)
+### Hierarchical
+#### Market Cap Treemap (plotly-print: 52.6ms | Kaleido: 1625.4ms)
+![Market Cap Treemap](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_treemap.png)
+#### Global Sunburst Hierarchy (plotly-print: 61.8ms | Kaleido: 1723.9ms)
+![Global Sunburst Hierarchy](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_sunburst.png)
+#### Icicle Partition Chart (plotly-print: 50.2ms | Kaleido: 1594.7ms)
+![Icicle Partition Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_icicle.png)
+### Radial & Polar
+#### Radar Performance Comparison (plotly-print: 96.5ms | Kaleido: 2481.9ms)
+![Radar Performance Comparison](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_scatterpolar.png)
+#### Polar Wind Rose (plotly-print: 77.5ms | Kaleido: 1826.6ms)
+![Polar Wind Rose](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_barpolar.png)
+### Specialized Diagrams
+#### Energy Flow Sankey Diagram (plotly-print: 51.7ms | Kaleido: 1708.4ms)
+![Energy Flow Sankey Diagram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_sankey.png)
+#### Parallel Categories Diagram (plotly-print: 57.0ms | Kaleido: 1620.2ms)
+![Parallel Categories Diagram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_parcats.png)
+#### Formatted Data Table (plotly-print: 69.9ms | Kaleido: 1766.4ms)
+![Formatted Data Table](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_table.png)
+#### Carpet Coordinate Plot (plotly-print: 86.1ms | Kaleido: 1792.2ms)
+![Carpet Coordinate Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_carpet.png)
+### Layout edge cases
+#### Bar chart with X labels at 45 deg (plotly-print: 89.0ms | Kaleido: 1673.2ms)
+![Bar chart with X labels at 45 deg](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_rotated_ticks_45.png)
+#### Bar chart with X labels at 90 deg (plotly-print: 87.7ms | Kaleido: 1883.9ms)
+![Bar chart with X labels at 90 deg](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_rotated_ticks_90.png)
+#### Annotation arrowheads (incl. circle) (plotly-print: 82.4ms | Kaleido: 1661.6ms)
+![Annotation arrowheads (incl. circle)](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_annotations_arrowheads.png)
+#### Long annotation arrows (dasharray length) (plotly-print: 79.7ms | Kaleido: 1719.1ms)
+![Long annotation arrows (dasharray length)](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_annotations_long_arrows.png)
+#### Table cells with HTML markup and entities (plotly-print: 74.8ms | Kaleido: 1692.5ms)
+![Table cells with HTML markup and entities](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_table_markup.png)
+<!-- BENCHMARK-END -->
+## 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.2.2/README.md ADDED Viewed

@@ -0,0 +1,235 @@
+# 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)
+Export Plotly figures to SVG, PNG, JPEG, or WebP without launching Chrome.
+plotly-print runs a bundled Plotly.js 2D build in QuickJS, then uses `resvg-py` for raster output. It works offline, has no browser process to install or manage, and can replace Plotly's image-export methods with one call.
+- Browser-free: no Chrome, Chromium, or Playwright.
+- Fast: avoids browser startup; see the measured [benchmarks](#benchmarks).
+- Familiar: use the direct API or patch Plotly's existing `to_image` and `write_image` methods.
+[Install](#installation) | [Direct API](#direct-api) | [Plotly integration](#plotly-integration) | [Benchmarks](#benchmarks)
+## Installation
+```bash
+pip install plotly-print
+```
+Requires Python 3.12 or newer.
+## Direct API
+```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')
+```
+`to_image` returns bytes. `write_image` writes to a path or binary file object. Supported formats are SVG, PNG, JPEG, and WebP.
+## Plotly integration
+Patch Plotly's existing image-export methods:
+```python
+import plotly_print
+plotly_print.register()
+```
+After registration, existing calls such as `fig.write_image("chart.png")` use plotly-print. Call `plotly_print.unregister()` to restore Plotly's original methods.
+plotly-print targets 2D static charts. The bundled Plotly.js build and its licenses are documented in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+<!-- BENCHMARK-START -->
+## Benchmarks
+On this run, plotly-print exported all 30 chart types **12x to 33x faster** than Kaleido.
+These are mean per-image PNG export times after both engines were warmed up. Timings are machine-specific; use the side-by-side images below to evaluate rendering differences.
+See the [raw results](assets/benchmarks/benchmark_summary.json) or [run the benchmark locally](CONTRIBUTING.md#kaleido-visual-benchmark).
+| Category                 | Chart Type                                |  Kaleido  | plotly-print |  Speedup  |
+| :----------------------- | :---------------------------------------- | :-------: | :----------: | :-------: |
+| **Core Cartesian**       | Scatter & Line Chart                      | 1668.5 ms | **88.2 ms**  | **18.9x** |
+| **Core Cartesian**       | Grouped Bar Chart                         | 1758.1 ms | **81.3 ms**  | **21.6x** |
+| **Core Cartesian**       | Donut / Pie Chart                         | 1628.6 ms | **73.6 ms**  | **22.1x** |
+| **Core Cartesian**       | Box Plot                                  | 1748.2 ms | **77.1 ms**  | **22.7x** |
+| **Core Cartesian**       | Violin Plot                               | 1623.8 ms | **84.1 ms**  | **19.3x** |
+| **Core Cartesian**       | Frequency Histogram                       | 1878.0 ms | **62.7 ms**  | **30.0x** |
+| **Core Cartesian**       | 2D Density Histogram                      | 1949.4 ms | **98.8 ms**  | **19.7x** |
+| **Core Cartesian**       | 2D Contour Plot                           | 1604.9 ms | **118.7 ms** | **13.5x** |
+| **Core Cartesian**       | Performance Heatmap                       | 1832.4 ms | **87.3 ms**  | **21.0x** |
+| **Core Cartesian**       | Ternary Phase Diagram                     | 1724.9 ms | **84.9 ms**  | **20.3x** |
+| **Financial & Business** | Candlestick Stock Chart                   | 1741.1 ms | **140.5 ms** | **12.4x** |
+| **Financial & Business** | OHLC Financial Chart                      | 1670.0 ms | **131.3 ms** | **12.7x** |
+| **Financial & Business** | Waterfall Profit & Loss                   | 1793.0 ms | **64.7 ms**  | **27.7x** |
+| **Financial & Business** | Sales Conversion Funnel                   | 1629.9 ms | **91.1 ms**  | **17.9x** |
+| **Financial & Business** | Funnel Area Analysis                      | 1694.0 ms | **61.7 ms**  | **27.5x** |
+| **Financial & Business** | KPI Performance Indicator                 | 1634.1 ms | **57.2 ms**  | **28.6x** |
+| **Hierarchical**         | Market Cap Treemap                        | 1625.4 ms | **52.6 ms**  | **30.9x** |
+| **Hierarchical**         | Global Sunburst Hierarchy                 | 1723.9 ms | **61.8 ms**  | **27.9x** |
+| **Hierarchical**         | Icicle Partition Chart                    | 1594.7 ms | **50.2 ms**  | **31.7x** |
+| **Radial & Polar**       | Radar Performance Comparison              | 2481.9 ms | **96.5 ms**  | **25.7x** |
+| **Radial & Polar**       | Polar Wind Rose                           | 1826.6 ms | **77.5 ms**  | **23.6x** |
+| **Specialized Diagrams** | Energy Flow Sankey Diagram                | 1708.4 ms | **51.7 ms**  | **33.1x** |
+| **Specialized Diagrams** | Parallel Categories Diagram               | 1620.2 ms | **57.0 ms**  | **28.4x** |
+| **Specialized Diagrams** | Formatted Data Table                      | 1766.4 ms | **69.9 ms**  | **25.3x** |
+| **Specialized Diagrams** | Carpet Coordinate Plot                    | 1792.2 ms | **86.1 ms**  | **20.8x** |
+| **Layout edge cases**    | Bar chart with X labels at 45 deg         | 1673.2 ms | **89.0 ms**  | **18.8x** |
+| **Layout edge cases**    | Bar chart with X labels at 90 deg         | 1883.9 ms | **87.7 ms**  | **21.5x** |
+| **Layout edge cases**    | Annotation arrowheads (incl. circle)      | 1661.6 ms | **82.4 ms**  | **20.2x** |
+| **Layout edge cases**    | Long annotation arrows (dasharray length) | 1719.1 ms | **79.7 ms**  | **21.6x** |
+| **Layout edge cases**    | Table cells with HTML markup and entities | 1692.5 ms | **74.8 ms**  | **22.6x** |
+## Visual comparisons
+Side-by-side PNGs (Kaleido left, plotly-print right):
+### Core Cartesian
+#### Scatter & Line Chart (plotly-print: 88.2ms | Kaleido: 1668.5ms)
+![Scatter & Line Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_scatter_line.png)
+#### Grouped Bar Chart (plotly-print: 81.3ms | Kaleido: 1758.1ms)
+![Grouped Bar Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_bar.png)
+#### Donut / Pie Chart (plotly-print: 73.6ms | Kaleido: 1628.6ms)
+![Donut / Pie Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_pie.png)
+#### Box Plot (plotly-print: 77.1ms | Kaleido: 1748.2ms)
+![Box Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_box.png)
+#### Violin Plot (plotly-print: 84.1ms | Kaleido: 1623.8ms)
+![Violin Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_violin.png)
+#### Frequency Histogram (plotly-print: 62.7ms | Kaleido: 1878.0ms)
+![Frequency Histogram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_histogram.png)
+#### 2D Density Histogram (plotly-print: 98.8ms | Kaleido: 1949.4ms)
+![2D Density Histogram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_histogram2d.png)
+#### 2D Contour Plot (plotly-print: 118.7ms | Kaleido: 1604.9ms)
+![2D Contour Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_contour.png)
+#### Performance Heatmap (plotly-print: 87.3ms | Kaleido: 1832.4ms)
+![Performance Heatmap](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_heatmap.png)
+#### Ternary Phase Diagram (plotly-print: 84.9ms | Kaleido: 1724.9ms)
+![Ternary Phase Diagram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_scatterternary.png)
+### Financial & Business
+#### Candlestick Stock Chart (plotly-print: 140.5ms | Kaleido: 1741.1ms)
+![Candlestick Stock Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_candlestick.png)
+#### OHLC Financial Chart (plotly-print: 131.3ms | Kaleido: 1670.0ms)
+![OHLC Financial Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_ohlc.png)
+#### Waterfall Profit & Loss (plotly-print: 64.7ms | Kaleido: 1793.0ms)
+![Waterfall Profit & Loss](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_waterfall.png)
+#### Sales Conversion Funnel (plotly-print: 91.1ms | Kaleido: 1629.9ms)
+![Sales Conversion Funnel](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_funnel.png)
+#### Funnel Area Analysis (plotly-print: 61.7ms | Kaleido: 1694.0ms)
+![Funnel Area Analysis](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_funnelarea.png)
+#### KPI Performance Indicator (plotly-print: 57.2ms | Kaleido: 1634.1ms)
+![KPI Performance Indicator](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_indicator.png)
+### Hierarchical
+#### Market Cap Treemap (plotly-print: 52.6ms | Kaleido: 1625.4ms)
+![Market Cap Treemap](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_treemap.png)
+#### Global Sunburst Hierarchy (plotly-print: 61.8ms | Kaleido: 1723.9ms)
+![Global Sunburst Hierarchy](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_sunburst.png)
+#### Icicle Partition Chart (plotly-print: 50.2ms | Kaleido: 1594.7ms)
+![Icicle Partition Chart](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_icicle.png)
+### Radial & Polar
+#### Radar Performance Comparison (plotly-print: 96.5ms | Kaleido: 2481.9ms)
+![Radar Performance Comparison](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_scatterpolar.png)
+#### Polar Wind Rose (plotly-print: 77.5ms | Kaleido: 1826.6ms)
+![Polar Wind Rose](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_barpolar.png)
+### Specialized Diagrams
+#### Energy Flow Sankey Diagram (plotly-print: 51.7ms | Kaleido: 1708.4ms)
+![Energy Flow Sankey Diagram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_sankey.png)
+#### Parallel Categories Diagram (plotly-print: 57.0ms | Kaleido: 1620.2ms)
+![Parallel Categories Diagram](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_parcats.png)
+#### Formatted Data Table (plotly-print: 69.9ms | Kaleido: 1766.4ms)
+![Formatted Data Table](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_table.png)
+#### Carpet Coordinate Plot (plotly-print: 86.1ms | Kaleido: 1792.2ms)
+![Carpet Coordinate Plot](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_carpet.png)
+### Layout edge cases
+#### Bar chart with X labels at 45 deg (plotly-print: 89.0ms | Kaleido: 1673.2ms)
+![Bar chart with X labels at 45 deg](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_rotated_ticks_45.png)
+#### Bar chart with X labels at 90 deg (plotly-print: 87.7ms | Kaleido: 1883.9ms)
+![Bar chart with X labels at 90 deg](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_rotated_ticks_90.png)
+#### Annotation arrowheads (incl. circle) (plotly-print: 82.4ms | Kaleido: 1661.6ms)
+![Annotation arrowheads (incl. circle)](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_annotations_arrowheads.png)
+#### Long annotation arrows (dasharray length) (plotly-print: 79.7ms | Kaleido: 1719.1ms)
+![Long annotation arrows (dasharray length)](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_annotations_long_arrows.png)
+#### Table cells with HTML markup and entities (plotly-print: 74.8ms | Kaleido: 1692.5ms)
+![Table cells with HTML markup and entities](https://raw.githubusercontent.com/roman-kaczanowski/plotly-print/main/assets/benchmarks/compare_table_markup.png)
+<!-- BENCHMARK-END -->
+## 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 → plotly_print-0.2.2}/THIRD_PARTY_NOTICES.md RENAMED Viewed

@@ -2,12 +2,12 @@
 ## plotly.js
-File: `src/plotly_print/js/plotly-cartesian.min.js`
+File: `src/plotly_print/js/plotly_comprehensive_2d.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.
+Redistributed plotly.js build (minified) used for offline / isolated 2D static
+rendering in the embedded QuickJS runtime. The full `plotly.min.js` shipped with
+the `plotly` Python package does not load in that runtime, so this smaller
+bundle is included instead.
 Copyright 2012-2026, Plotly, Inc.
 All rights reserved.

plotly-print 0.1.0__tar.gz → 0.2.2__tar.gz

plotly-print 0.1.0tar.gz → 0.2.2tar.gz