Kaleido v1 introduces a new API. If you're currently using v0, you'll need to make changes to your code and environment where you are running Kaleido.

• If using Kaleido v1 with Plotly.py, you will need to install Plotly.py v6.1.1 or later.
• Chrome is no longer included with Kaleido. Kaleido will look for an existing Chrome installation, but also provides commands for installing Chrome. If you don't have Chrome, you'll need to install it. See the installation section above for instructions.
• If your code uses Kaleido directly: kaleido.scopes.plotly has been removed in v1. Kaleido v1 provides write_fig and write_fig_sync for exporting Plotly figures.

What's Changed

• Andrew/easier builds by @ayjayt in #315
• Add pass through kopts dict for kaleido args by @ayjayt in #316
• Handle mathjax arg when passed to Kaleido constructor by @emilykl in #320
• Add Changelog by @ayjayt in #321
• Add migration guide and make small updates by @LiamConnors in #314
• Rename LICENSE.md to LICENSE by @tschm in #330
• Update GHA by @ayjayt in #329
• Pass plotlyjs arg to PageGenerator constructor by @emilykl in #336
• Andrew/fix gha by @ayjayt in #337
• Fix package name in GHA by @ayjayt in #338
• Escape user-supplied strings regex by @ayjayt in #339
• Andrew/sanitize title by @ayjayt in #340

New Contributors

• @emilykl made their first contribution in #320
• @tschm made their first contribution in #330

Full Changelog: v1.0.0rc11...v1.0.0rc15

This is a pre-release version of Kaleido 1.0.0 which contains a number of breaking changes relative to Kaleido 0.x. It is not compatible with the latest release of Plotly. To generate images with Plotly you should install the latest stable version of and Kaleido (v0.2.1).

Documentation for the new API can be found in the README: https://github.com/plotly/Kaleido

What's Changed

• merge devtools/main by @ayjayt in #206
• cause kaleido to explicitly fail if no chromium: by @ayjayt in #224

Full Changelog: v0.4.0.rc.5...v1.0.0-rc.0

Full Changelog: v0.4.0-rc.4...v0.4.0.rc.5

Full Changelog: v0.4.0-rc.3...v0.4.0-rc.4

What's Changed

• Set daemon attribute directly by @Joilence in #146
• Display error stream when interrupting the program by @Lucas-C in #160
• Fix Windows Build by @ayjayt in #179
• fix: use /usr/bin/env to find bash by @ayjayt in #203
• Properly quote Unix launch scripts by @BlueDrink9 in #199
• Update README and LICENSE and add code of conduct by @gvwilson in #208

New Contributors

• @Joilence made their first contribution in #146
• @Lucas-C made their first contribution in #160
• @BlueDrink9 made their first contribution in #199
• @gvwilson made their first contribution in #208

Full Changelog: v0.2.1.post1...v0.4.0-rc.3

Adds arm32 support, no changes to other architectures so they aren't published with this tag.

Fixed:

• Circular import error with some Python 3.6 environments (plotly/plotly.py#3101)

Added

• Apple silicon support (#71)
• Bundle and autodetect MathJax to support offline MathJax rendering in plotly figures (#75, plotly/plotly.py#3094).

Updated

• Raise plotGlPixelRatio with scale to increase resolution of WebGL portions of figures as figure scale is increased (#58, #76). Note that not all plotly.js WebGL traces support plotGlPixelRatio, see plotly/plotly.js#5500 for ongoing work in that area.
• Automatically include the --single-process chromium flag when running on AWS Lambda to make Kaleido work by default in that environment (#74, #76)
• Refactor how plotly.py JSON encoding is performed to take advantage of the future JSON encoding performance enhancements coming in plotly.py version 5 (plotly/plotly.py#2955, #76)
• Update base chromium build to 88.0.4324.150 (#71)

Fixed

• Honor the figure dimensions specified in the figure template (#62, #76)