Saving a plotly image not working with kaleido even though it is installed

Question

I am trying to save a simple plotly figure to a directory. I understand it needs kaleido (I have version '0.2.1') and also at least plotly '5.3.1' which are installed.

However trying to save the image I get the following error:

fig.write_image(path)

ValueError: 
Image export using the "kaleido" engine requires the kaleido package,
which can be installed using pip:
$ pip install -U kaleido

Why is this occuring when all the required packages are there?

Twelvemonth

What happens if you insert the line import kaleido; print(kaleido.__version__) before fig.write_image(path)` – Casta

@DerekO I get 0.2.1 – Twelvemonth

are you working in a virtual environment? Do you get the same error if you run your code in terminal? – Casta

I can't run that in the terminal. What command should I run @DerekO – Twelvemonth

in terminal, what if you try fig=go.Figure() and then fig.write_image('test.png') ? – Casta

I get an error. Are you sure you don't mean the console? – Twelvemonth

Did you ever figure this out? Having same issue. – Pancho

@Pancho unfortunately not, I just moved on without. – Twelvemonth

Answer 1

I've got exactly the same issue on google colab. Even after installation kaleido, the same error. Accidentally I've found fix, it seems necesarry to import kaleido first:

!pip install kaleido
import kaleido #required
kaleido.__version__ #0.2.1

import plotly
plotly.__version__ #5.5.0

#now this works:
import plotly.graph_objects as go

fig = go.Figure()
fig.write_image('aaa.png')

Eweneck

Answer 2

The transition from Orca to Kaleido is not without speed bumps.

For users on Windows 10 and 11, users seem to have luck rolling back to Kaleido version 0.1.0, see. https://github.com/plotly/Kaleido/issues/110

Stallfeed

Answer 3

Got this exact issue on colab and tried all options but didn't work. Then, found out that if you revert Plotly to version 5.3.1, the issue goes away. Not the best fix, but was the only thing that worked for me.

!pip uninstall ploty !pip install plotly==5.3.1 import plotly import kaleido

Stative

Answer 4

I ran into a similar problem on Windows 10. It turned out to solve the problem by changing the rendering method

set KALIDO_USE_SWIFT=true

Pericardium

Answer 5

I got the same problem in a Jupyter Notebook and got it to work by restarting the kernel and then specifying one more argument: engine="kaleido". Your mileage may vary...

import kaleido
import plotly.io as pio

pio.write_image(my_file, 'path/to/my/directory/file.svg', engine="kaleido")

Hyacinthus