Pre-Launch Kaleido v1.0.0

Kaleido allows you to convert plotly figures to images.

pip install kaleido

Right now, Kaledio v1.0.0 is available as a release candidate:

• download v1.0.0rc2 explicitly or
• enable whatever installer you use (pip --pre?) to use release candidates

Kaleido's strategy has changed: chrome is no longer included. On the other hand, it's much faster and supports parallel processing and memory-saving techniques.

Kaleido will try to use your own platform's chrome, but we recommend the following:

$ kaleido_get_chrome

or

import kaleido
await kaleido.get_chrome()
# or
# kaleido.get_chrome_sync()

Quickstart

import kaleido

# fig is a plotly figure or an iterable of plotly figures

# Those are the defaults! 4 processes, 90 seconds.
async with kaleido.Kaleido(n=4, timeout=90) as k:
  await k.write_fig(fig, path="./", opts={"format":"jpg"}) # default format is `png`

# Kaleido arguments:
# - n: how many processors to use
# - timeout: Set a timeout on any single image write
# - page: Customize the version of mathjax/plotly used

# Kaleido.write_fig arguments:
# - fig: a single plotly figure or an iterable
# - path: A directory (names will be auto-generated based on title) or a single file
# - opts: a dictionary with image options:
#         {"scale":, "format":, "width":, "height":}
# - error_log: If you pass a list here, image-generation errors will be appended
#              to the list and generation continues. If left as None, the first error
#              will cause failure.

# You can also use Kaleido.write_fig_from_object:
  await k.write_fig_from_object(fig_objects, error_log)

# where fig_objects is an iterable of dictionaries that have
# {"fig":, "path":, "opts":} keys corresponding to above.

There are shortcut functions if just want dont want to create a Kaleido().

import asyncio
import kaleido
asyncio.run(
            kaleido.write_fig(
                              fig,
                              path="./",
                              n=4
                              )
            )

However, if you want to set timeout or custom page, you must use a Kaleido().

PageGenerators

Kaleido(page=???) takes a kaleido.PageGenerator() to customize versions.

my_page = kaleido.PageGenerator(
                      plotly="A fully qualified link to plotly (https:// or file://)",
                      mathjax=False # no mathjax, or another fully quality link
                      others=["a list of other script links to include"]
                      )
async with kaleido.Kaleido(n=4, page=my_page) as k:
  ...

More info

See the Plotly static image export documentation for more information.