Skip to main content

Plotly graph export library

Reason this release was yanked:

re-thinking version numbering for breaking change

Project description

Kaleido

Kaleido is a cross-platform library for generating static images for Plotly's visualization library. After installing it, you can use fig.write_image("filename.png") to save a plot to a file.

How It Works

The original version of kaleido included a custom build of the Chrome web browser, which made it very large (hundreds of megabytes) and proved very difficult to maintain. In contrast, this version depends on choreographer, a lightweight library that enables remote control of browsers from Python. When you ask kaleido to create an image, it uses choreographer to run a headless instance of Chrome to render and save your figure. Please see choreographer's documentation for details.

The new version of kaleido is a work on progress; we would be grateful for help testing it and improving it. If you find a bug, please report it in our GitHub repository, and please include a minimal reproducible example if you can.

It would also be very helpful to run the script src/py/tests/manual.py and attach its zipped output to your bug report. This will give us detailed information about the precise versions of software you are using and the platform you are running on, which will help us track down problems more quickly.

Installation

You can install kaleido from PyPI using pip:

$ pip install kaleido

Use

Versions 4.9 and above of the Plotly Python library will automatically use kaleido for static image export when kaleido is installed. For example:

import plotly.express as px
fig = px.scatter(px.data.iris(), x="sepal_length", y="sepal_width", color="species")
fig.write_image("figure.png", engine="kaleido")

See the Plotly static image export documentation for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kaleido-0.4.2.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

kaleido-0.4.2-py3-none-any.whl (3.8 MB view details)

Uploaded Python 3

File details

Details for the file kaleido-0.4.2.tar.gz.

File metadata

  • Download URL: kaleido-0.4.2.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for kaleido-0.4.2.tar.gz
Algorithm Hash digest
SHA256 1b3043290b443b6dda7eea3b0d08ae59232a707896a8a77f36a56611bf4e17c4
MD5 9f2fbc96f9e1d1dc81b8a9e32b05a55a
BLAKE2b-256 8e95da101d3223875ae891767e296b248a2e8a85f6063315ef0745e29d63ea1b

See more details on using hashes here.

File details

Details for the file kaleido-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: kaleido-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 3.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for kaleido-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cc0ecb6f8c7e33fa1a49b3f15f182b80d9c5401cabde75e272239ce540fe5d82
MD5 4d5debafd10f30b883a7c86d609dcc63
BLAKE2b-256 e6ee542496ca9dc2b4827889dae3966188619d06e4ed0f52746d2066c99bb5ba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page