Skip to content
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

document usage of an externally hosted Orca instance #2034

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/python/static-image-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@ If you are unable to install conda or npm, you can install orca as a precompiled
```
$ pip install psutil requests
```

##### Externally Hosted Orca + pip
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why "+ pip" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why "+ pip" ?

I copied the title style of the other subsections. Would you prefer me to remove it?

P.S. One still needs to install dependencies via pip namely requests and psutil (the requirement for the latter could/should be removed but atm it's mandatory) for this feature to work.

If you already run an instance of [orca](https://github.com/plotly/orca) on your network, there's no need to install it.
You can simply point to it in your Python code.

```python
import plotly
# specify URL to Orca's endpoint
plotly.io.orca.config.server_url = "http://localhost:9091"
```

Note that for this to work, you still need to first `requests` and `psutil`.

<!-- #endregion -->

### Create a Figure
Expand Down