An open-source, interactive graphing library for Python
Switch branches/tags
Clone or download
jonmmease offline.plot/iplot improvements (#1234)
* Support auto-resize in offline.plot with output_type='div' and include_plotlyjs=False
* Support auto-resize for classic notebook iplot
* Add 'cdn' and 'directory' include_plotlyjs options in offline.plot.  When 'cdn', the resulting html file/div includes a script tag reference
to the plotlyjs cdn. When 'directory', the resulting html file/div includes a script tag
reference to a plotly.min.js bundle in the same directory as the html
file. If output_type is 'file' then this plotly.min.js bundle is
created in the output directory if it doesn't already exist.
* Add option to specify include_plotlyjs as a path/url to a *.js file.  This makes it possible to specify an alternative CDN or offline
location for plotly.js
Latest commit defab4c Oct 23, 2018
Permalink
Failed to load latest commit information.
.circleci Add no_output_timeout of 20m for conda packaging command. Sep 8, 2018
.github add issue template Jun 15, 2018
_plotly_utils Use uuid4 instead of uuid1 to generate trace uid (#1236) Oct 23, 2018
codegen Add support for 2D arrays in InfoArrayValidator (#1240) Oct 23, 2018
example_images Review and updates to migration guide Jul 4, 2018
js Release 3.3.0 (#1205) Sep 28, 2018
plotly offline.plot/iplot improvements (#1234) Oct 23, 2018
plotlywidget Release 3.3.0 (#1205) Sep 28, 2018
recipe Fix licence name in manifest and update license copyright year (#1196) Sep 25, 2018
specs Remove old ipyplotly_integration notebooks. Sep 1, 2018
submodules update chunked requests sub mods. Jun 6, 2016
templategen Templates (themes) integration (#1224) Oct 23, 2018
test/vv/lib/python2.7/site-packages/plotly typo Apr 12, 2017
.gitignore [WIP] Use circleci to build conda packages (#1154) Sep 4, 2018
.gitmodules go back to using git protocol Nov 25, 2015
CHANGELOG.md Release 3.3.0 (#1205) Sep 28, 2018
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
MANIFEST.in Fix licence name in manifest and update license copyright year (#1196) Sep 25, 2018
README.md Release 3.3.0 (#1205) Sep 28, 2018
README.rst a pull May 30, 2017
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 Release 3.3.0 (#1205) Sep 28, 2018
make_instructions.txt Remove `refs` stuff from makefile and instructions Sep 30, 2015
makefile Update plotly.js to explicitly defined version by downloading from pl… Jun 11, 2018
migration-guide.md A few updates to the migration guide (#1048) Jul 6, 2018
optional-requirements.txt Templates (themes) integration (#1224) Oct 23, 2018
package-lock.json Big refactor of codegen and project output structure Mar 25, 2018
plotlywidget.json Remove the need to manually install widget extension in classic notebook Jun 12, 2018
requirements.txt Orca integration for static image export (#1120) Aug 25, 2018
setup.cfg Release 3.1.1 (#1096) Aug 10, 2018
setup.py Templates (themes) integration (#1224) Oct 23, 2018
tox.ini Add to/from/read/write json functions to the plotly.io module (#1188) Sep 21, 2018

README.md

plotly.py

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==3.3.0

or conda.

conda install -c plotly plotly=3.3.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.2"

or conda.

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

JupyterLab Support (Python 3.5+)

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

pip install jupyterlab==0.34 "ipywidgets>=7.2"

or conda.

conda install jupyterlab=0.34 "ipywidgets>=7.2"

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@0.37 --no-build

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

# offline iplot support
jupyter labextension install @jupyterlab/plotly-extension@0.17.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.

Migration

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

Copyright and Licenses

Code and documentation copyright 2018 Plotly, Inc.

Code released under the MIT license.

Docs released under the Creative Commons license.