Skip to content

Commit 43f6236

Browse files
committed
Reorganize README and add link to migration guide
1 parent a439aff commit 43f6236

File tree

1 file changed

+30
-24
lines changed

1 file changed

+30
-24
lines changed

Diff for: README.md

+30-24
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,6 @@
11
# plotly.py
22

3-
## Instal Plotly 3.0.0rc10
4-
To install and enable with Jupyter or Jupyter lab, run:
5-
```
6-
pip install plotly==3.0.0rc9
7-
pip install "notebook>=5.3" "ipywidgets>=7.2" # only necessary for Jupyter Notebook environments
8-
```
9-
10-
If you're using older versions of `notebook` or `ipywidgets` you may need to manually activate the widget extensions (this should not be needed for `notebook>=5.3` and `ipywidgets>=7.2`)
11-
12-
```
13-
jupyter nbextension enable --py widgetsnbextension --sys-prefix
14-
jupyter nbextension enable --py plotlywidget --sys-prefix
15-
```
16-
17-
In addition, to add JupyterLab support run the following commands
18-
19-
```
20-
pip install jupyterlab
21-
export NODE_OPTIONS=--max-old-space-size=4096
22-
jupyter labextension install @jupyter-widgets/jupyterlab-manager # install the Jupyter widgets extension
23-
jupyter labextension install plotlywidget
24-
```
25-
3+
## Overview
264
[plotly.py](https://plot.ly/d3-js-for-python-and-pandas-charts/) is an interactive, browser-based graphing library for Python :sparkles:
275

286
Built on top of [plotly.js](https://github.com/plotly/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.
@@ -39,13 +17,41 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
3917
***
4018

4119
- [Online Documentation](https://plot.ly/python)
42-
- [`contributing.md`](https://github.com/plotly/python-api/blob/master/contributing.md)
20+
- [Contributing](contributing.md)
21+
- [Changelog](CHANGELOG.md)
4322
- [Code of Conduct](CODE_OF_CONDUCT.md)
23+
- [Version 3 Migration Guide](migration-guide.md)
4424
- [New! Announcing Dash](https://medium.com/@plotlygraphs/introducing-dash-5ecf7191b503)
4525
- [Community](https://community.plot.ly/c/api/python)
4626

4727
***
4828

29+
## Installation Plotly 3.0.0rc11
30+
To install and enable with Jupyter or Jupyter Lab, run:
31+
```
32+
pip install plotly==3.0.0rc11
33+
pip install "notebook>=5.3" "ipywidgets>=7.2" # only necessary for Jupyter Notebook environments
34+
```
35+
36+
If you're using older versions of `notebook` or `ipywidgets` you may need to manually activate the widget extensions (this should not be needed for `notebook>=5.3` and `ipywidgets>=7.2`)
37+
38+
```
39+
jupyter nbextension enable --py widgetsnbextension --sys-prefix
40+
jupyter nbextension enable --py plotlywidget --sys-prefix
41+
```
42+
43+
In addition, to add JupyterLab support run the following commands
44+
45+
```
46+
pip install jupyterlab
47+
export NODE_OPTIONS=--max-old-space-size=4096
48+
jupyter labextension install @jupyter-widgets/jupyterlab-manager # install the Jupyter widgets extension
49+
jupyter labextension install plotlywidget
50+
```
51+
52+
If you're migrating from plotly.py version 2, please check out the [migration guid](migration-guide.md)
53+
54+
## Copyright and Licenses
4955
Code and documentation copyright 2017 Plotly, Inc.
5056

5157
Code released under the [MIT license](LICENSE.txt).

0 commit comments

Comments
 (0)