Skip to content
An open-source, interactive graphing library for Python
Python JavaScript PostScript TypeScript Jupyter Notebook Shell
Branch: master
Clone or download
Bharat123rox and jonmmease Update README.md for possible collision of `orca` executable (#1519)
* Update README.md for possible collision of `orca` executable
* Move to the "Static Image Export" section. Moved troubleshooting section inside the "Static Image Export" section. Updates to wording
Latest commit 6eb94f0 Aug 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci V4 refine dependencies (#1631) Jun 19, 2019
.github Create FUNDING.yml May 28, 2019
packages Release 4.1.0 (#1704) Aug 7, 2019
submodules V4 remove chunked_requests submodule (#1627) Jun 19, 2019
test/vv/lib/python2.7/site-packages/plotly V4 insitute code formatting standard using Black (#1626) Jun 18, 2019
.gitattributes CI workflow to build plotly.py against latest plotly.js master (#1440) Feb 22, 2019
.gitignore Don't ignore dataset files, add files Jun 25, 2019
.gitmodules go back to using git protocol Nov 25, 2015
.pre-commit-config.yaml V4 insitute code formatting standard using Black (#1626) Jun 18, 2019
CHANGELOG.md Release 4.1.0 (#1704) Aug 7, 2019
CODE_OF_CONDUCT.md a pull May 30, 2017
LICENSE.txt Fix licence name in manifest and update license copyright year (#1196) Sep 25, 2018
README.md Update README.md for possible collision of `orca` executable (#1519) Aug 17, 2019
bld.bat build for conda Jul 28, 2016
build.sh build for conda Jul 28, 2016
build_for_conda.md build for conda Jul 28, 2016
compatibility.md Depreciated is a bit different than deprecated. Jul 28, 2014
contributing.md V4 insitute code formatting standard using Black (#1626) Jun 18, 2019
make_instructions.txt Remove `refs` stuff from makefile and instructions Sep 30, 2015
migration-guide.md Update migration guide to reference v4-migration documentation page Jul 8, 2019
pyproject.toml V4 remove chunked_requests submodule (#1627) Jun 19, 2019
setup_submodules.py V4 remove chunked_requests submodule (#1627) Jun 19, 2019

README.md

plotly.py

Latest Release
PyPI Downloads
License

Quickstart

pip install plotly "notebook>=5.3" "ipywidgets>=7.2"

Inside Jupyter notebook:

import plotly.graph_objs as go
fig = go.FigureWidget()
# Display an empty figure
fig
# Add a scatter chart
fig.add_scatter(y=[2, 1, 4, 3])
# Add a bar chart
fig.add_bar(y=[1, 4, 3, 2])
# Add a title
fig.layout.title = 'Hello FigureWidget'

See the Python documentation for more examples.

Read about what's new in plotly.py v3

Overview

plotly.py is an interactive, open-source, and browser-based graphing library for Python

Built on top of plotly.js, plotly.py is a high-level, declarative charting library. plotly.js ships with over 30 chart types, including scientific charts, 3D graphs, statistical charts, SVG maps, financial charts, and more.

plotly.py is MIT Licensed. Plotly graphs can be viewed in Jupyter notebooks, standalone HTML files, or hosted online on plot.ly.

Contact us for Plotly.js consulting, dashboard development, application integration, and feature additions. Sharing your graphs online or in dashboards? Consider a plot.ly subscription.



Installation

plotly.py may be installed using pip...

pip install plotly==4.1.0

or conda.

conda install -c plotly plotly==4.1.0

Jupyter Notebook Support

For use in the Jupyter Notebook, install the notebook and ipywidgets packages using pip...

pip install "notebook>=5.3" "ipywidgets==7.5"

or conda.

conda install "notebook>=5.3" "ipywidgets=7.5"

JupyterLab Support (Python 3.5+)

For use in JupyterLab, install the jupyterlab and ipywidgets packages using pip...

pip install jupyterlab==1.0 "ipywidgets==7.5"

or conda.

conda install jupyterlab=1.0 "ipywidgets=7.5"

Then run the following commands to install the required JupyterLab extensions:

# Avoid "JavaScript heap out of memory" errors during extension installation
# (OS X/Linux)
export NODE_OPTIONS=--max-old-space-size=4096
# (Windows)
set NODE_OPTIONS=--max-old-space-size=4096

# Jupyter widgets extension
jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.0 --no-build

# FigureWidget support
jupyter labextension install plotlywidget@1.1.0 --no-build

# and jupyterlab renderer support
jupyter labextension install jupyterlab-plotly@1.1.0 --no-build

# JupyterLab chart editor support (optional)
jupyter labextension install jupyterlab-chart-editor@1.2 --no-build

# Build extensions (must be done to activate extensions since --no-build is used above)
jupyter lab build

# Unset NODE_OPTIONS environment variable
# (OS X/Linux)
unset NODE_OPTIONS
# (Windows)
set NODE_OPTIONS=

Static Image Export

plotly.py supports static image export using the to_image and write_image functions in the plotly.io package. This functionality requires the installation of the plotly orca command line utility and the psutil Python package.

These dependencies can both be installed using conda:

conda install -c plotly plotly-orca psutil

Or, psutil can be installed using pip...

pip install psutil

and orca can be installed according to the instructions in the orca README.

Troubleshooting

Wrong Executable found

If you get an error message stating that the orca executable that was found is not valid, this may be because another executable with the same name was found on your system. Please specify the complete path to the Plotly-Orca binary that you downloaded (for instance in the Miniconda folder) with the following command:

plotly.io.orca.config.executable = '/home/your_name/miniconda3/bin/orca'

Extended Geo Support

Some plotly.py features rely on fairly large geographic shape files. The county choropleth figure factory is one such example. These shape files are distributed as a separate plotly-geo package. This package can be installed using pip...

pip install plotly-geo==1.0.0

or conda

conda install -c plotly plotly-geo=1.0.0

Chart Studio support

The chart-studio package can be used to upload plotly figures to Plotly's Chart Studio Cloud or On-Prem service. This package can be installed using pip...

pip install chart-studio==1.0.0

or conda

conda install -c plotly chart-studio=1.0.0

Migration

If you're migrating from plotly.py version 3, please check out the Version 4 migration guide

If you're migrating from plotly.py version 2, please check out the Version 3 migration guide

Copyright and Licenses

Code and documentation copyright 2019 Plotly, Inc.

Code released under the MIT license.

Docs released under the Creative Commons license.

You can’t perform that action at this time.