Skip to content

Commit 8a787b5

Browse files
committed
Add deprecation notice for orca
1 parent c54a2bd commit 8a787b5

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/python/orca-management.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ jupyter:
55
text_representation:
66
extension: .md
77
format_name: markdown
8-
format_version: '1.1'
9-
jupytext_version: 1.1.6
8+
format_version: '1.3'
9+
jupytext_version: 1.16.4
1010
kernelspec:
11-
display_name: Python 3
11+
display_name: Python 3 (ipykernel)
1212
language: python
1313
name: python3
1414
language_info:
@@ -20,7 +20,7 @@ jupyter:
2020
name: python
2121
nbconvert_exporter: python
2222
pygments_lexer: ipython3
23-
version: 3.7.3
23+
version: 3.11.10
2424
plotly:
2525
description: This section covers the low-level details of how plotly.py uses orca
2626
to perform static image generation.
@@ -33,11 +33,11 @@ jupyter:
3333
thumbnail: thumbnail/orca-management.png
3434
---
3535

36+
> Support for orca 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.
37+
3638
### Overview
3739
This section covers the lower-level details of how plotly.py can use orca to perform static image generation.
3840

39-
> 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 .
40-
4141
Please refer to the [Static Image Export](/python/static-image-export/) section for general information on creating static images from plotly.py figures.
4242

4343
### What is orca?
@@ -50,26 +50,26 @@ There are 3 general approaches to installing orca and its Python dependencies.
5050

5151
##### conda
5252
Using the [conda](https://conda.io/docs/) package manager, you can install these dependencies in a single command:
53-
```
53+
<!-- #raw -->
5454
$ conda install -c plotly plotly-orca==1.2.1 psutil requests
55-
```
55+
<!-- #endraw -->
5656

5757
**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.
5858

5959
##### npm + pip
6060
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`:
6161

62-
```
62+
<!-- #raw -->
6363
$ npm install -g [email protected] orca
6464
$ pip install psutil requests
65-
```
65+
<!-- #endraw -->
6666

6767
##### Standalone Binaries + pip
6868
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`.
6969

70-
```
70+
<!-- #raw -->
7171
$ pip install psutil requests
72-
```
72+
<!-- #endraw -->
7373

7474
<!-- #region -->
7575
### Install orca on Google Colab
@@ -263,4 +263,4 @@ In addition to the `executable` property, the `plotly.io.orca.config` object can
263263

264264

265265
### Saving Configuration Settings
266-
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.
266+
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.

0 commit comments

Comments
 (0)