Kaleido is a standalone library for generating static images (PNG, JPEG, SVG, PDF, EPS) from web-based visualizations, primarily designed for Plotly.py figures. It is currently at version 1.2.0 and receives updates for bug fixes and feature enhancements, with a significant API overhaul in v1.0.0.
pip install kaleidoVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates the most common way to use Kaleido: through `plotly.io.write_image()` or directly on a `go.Figure` object. Kaleido is automatically detected and used by Plotly to render the static image. It highlights the importance of having a Chromium browser installed.
Refer to Kaleido v1.x documentation for new API usage. Ensure a Chromium-based browser is installed and accessible in your PATH, or use `python -m kaleido.cli install` to set one up.
Upgrade Plotly.py to version 6.1.1 or higher: `pip install "plotly>=6.1.1"`
Install a Chromium-based browser or use the Kaleido CLI to install Chromium: `python -m kaleido.cli install`. Ensure the browser is accessible in your system's PATH.
Wrap your sequential export calls with `kaleido.start_sync_server()` and `kaleido.stop_sync_server()` to reuse a single Kaleido process.
Install Plotly.py: `pip install plotly`. For Kaleido v1.0.0 and later, it is recommended to install `plotly>=6.1.1` to ensure compatibility.