-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Kaleido docs updates for v1 #5111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
49 commits
Select commit
Hold shift + click to select a range
8a787b5
Add deprecation notice for orca
LiamConnors 9dd3330
Create static-image-generation-migration.md
LiamConnors 97168bf
Add deprecation notice
LiamConnors ca80cdd
Add info on changes in Plotly.py 6.1
LiamConnors 7c76ee3
Add draft of Kaleido updates
LiamConnors 2e0b441
Add default settings info
LiamConnors 577329d
Make small updates and add back Orca export settings
LiamConnors 02b31f0
Update link
LiamConnors 3281d99
Update static-image-export.md
LiamConnors 2cbd63c
Update migration guide for Kaleido
LiamConnors 9855b6a
remove orca section
LiamConnors 28e7e19
Update static-image-export.md
LiamConnors e8149ae
Small updates
LiamConnors e45d56e
Merge branch 'main' into kaleido-docs-updates
LiamConnors 0b79a17
Update static-image-generation-migration.md
LiamConnors f8cad81
Merge branch 'kaleido-docs-updates' of https://github.com/plotly/plot…
LiamConnors f5ac772
Update doc/python/static-image-export.md
LiamConnors 10e8f20
Update doc/python/static-image-export.md
LiamConnors bbac70b
Update doc/python/static-image-export.md
LiamConnors 9ad552e
Update doc/python/static-image-export.md
LiamConnors c290b5f
Update doc/python/static-image-export.md
LiamConnors 7b8061b
Update static-image-generation-migration.md
LiamConnors 07fd630
Merge branch 'kaleido-docs-updates' of https://github.com/plotly/plot…
LiamConnors 6ba54f3
Update static-image-export.md
LiamConnors 30cc778
Update doc/python/static-image-generation-migration.md
LiamConnors 9b09504
Merge branch 'main' into kaleido-docs-updates
LiamConnors fded494
Merge branch 'kaleido-docs-updates' of https://github.com/plotly/plot…
LiamConnors 077a356
Add note on browsers
LiamConnors 2821776
Merge branch 'main' into kaleido-docs-updates
LiamConnors 9f9262b
Update doc/python/static-image-generation-migration.md
LiamConnors 551eaa6
update install commands
LiamConnors b9816bd
Merge branch 'kaleido-docs-updates' of https://github.com/plotly/plot…
LiamConnors 8a8b052
Update doc/python/static-image-export.md
LiamConnors fc13f1d
Update doc/python/static-image-generation-migration.md
LiamConnors 63229fc
Update doc/python/static-image-export.md
LiamConnors 2eeac47
Update doc/python/static-image-export.md
LiamConnors b42185e
Update doc/python/static-image-generation-migration.md
LiamConnors e753b7b
Update doc/python/static-image-generation-migration.md
LiamConnors 9fb73a1
Update doc/python/static-image-generation-migration.md
LiamConnors 0284d5e
Update doc/python/static-image-export.md
LiamConnors ff62066
Update doc/python/static-image-export.md
LiamConnors 41d72f0
Update doc/python/static-image-export.md
LiamConnors a27e2a9
Update static-image-export.md
LiamConnors 8e62339
Update static-image-export.md
LiamConnors b8253c4
Update static-image-generation-migration.md
LiamConnors ba8ab39
Update static-image-export.md
LiamConnors 2cc67f3
Update getting-started.md
LiamConnors 9be1a49
Update static-image-generation-migration.md
LiamConnors d3ba372
Merge branch 'main' into kaleido-docs-updates
LiamConnors File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,10 +5,10 @@ jupyter: | |
text_representation: | ||
extension: .md | ||
format_name: markdown | ||
format_version: '1.1' | ||
jupytext_version: 1.1.6 | ||
format_version: '1.3' | ||
jupytext_version: 1.16.4 | ||
kernelspec: | ||
display_name: Python 3 | ||
display_name: Python 3 (ipykernel) | ||
language: python | ||
name: python3 | ||
language_info: | ||
|
@@ -20,7 +20,7 @@ jupyter: | |
name: python | ||
nbconvert_exporter: python | ||
pygments_lexer: ipython3 | ||
version: 3.7.3 | ||
version: 3.11.10 | ||
plotly: | ||
description: This section covers the low-level details of how plotly.py uses orca | ||
to perform static image generation. | ||
|
@@ -33,11 +33,11 @@ jupyter: | |
thumbnail: thumbnail/orca-management.png | ||
--- | ||
|
||
> Orca support in Plotly.py is deprecated and will be removed after September 2025. See the [Static Image Export page](/python/static-image-export/) for details on using Kaleido for static image generation. | ||
|
||
### Overview | ||
This section covers the lower-level details of how plotly.py can use orca to perform static image generation. | ||
|
||
> As of `plotly` version 4.9, Orca is no longer the recommended way to do static image export. We now recommend Kaleido, as described in the [Static Image Export](/python/static-image-export/) section . | ||
|
||
Please refer to the [Static Image Export](/python/static-image-export/) section for general information on creating static images from plotly.py figures. | ||
|
||
### What is orca? | ||
|
@@ -50,26 +50,26 @@ There are 3 general approaches to installing orca and its Python dependencies. | |
|
||
##### conda | ||
Using the [conda](https://conda.io/docs/) package manager, you can install these dependencies in a single command: | ||
``` | ||
<!-- #raw --> | ||
$ conda install -c plotly plotly-orca==1.2.1 psutil requests | ||
``` | ||
<!-- #endraw --> | ||
|
||
**Note:** Even if you do not want to use conda to manage your Python dependencies, it is still useful as a cross platform tool for managing native libraries and command-line utilities (e.g. git, wget, graphviz, boost, gcc, nodejs, cairo, etc.). For this use-case, start with [Miniconda](https://conda.io/miniconda.html) (~60MB) and tell the installer to add itself to your system `PATH`. Then run `conda install plotly-orca==1.2.1` and the orca executable will be available system wide. | ||
|
||
##### npm + pip | ||
You can use the [npm](https://www.npmjs.com/get-npm) package manager to install `orca` (and its `electron` dependency), and then use pip to install `psutil`: | ||
|
||
``` | ||
<!-- #raw --> | ||
$ npm install -g [email protected] orca | ||
$ pip install psutil requests | ||
``` | ||
<!-- #endraw --> | ||
|
||
##### Standalone Binaries + pip | ||
If you are unable to install conda or npm, you can install orca as a precompiled binary for your operating system. Follow the instructions in the orca [README](https://github.com/plotly/orca) to install orca and add it to your system `PATH`. Then use pip to install `psutil`. | ||
|
||
``` | ||
<!-- #raw --> | ||
$ pip install psutil requests | ||
``` | ||
<!-- #endraw --> | ||
|
||
<!-- #region --> | ||
### Install orca on Google Colab | ||
|
@@ -263,4 +263,4 @@ In addition to the `executable` property, the `plotly.io.orca.config` object can | |
|
||
|
||
### Saving Configuration Settings | ||
Configuration options can optionally be saved to the `~/.plotly/` directory by calling the `plotly.io.config.save()` method. Saved setting will be automatically loaded at the start of future sessions. | ||
Configuration options can optionally be saved to the `~/.plotly/` directory by calling the `plotly.io.config.save()` method. Saved setting will be automatically loaded at the start of future sessions. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.