-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into merge-recent-docs-changes
- Loading branch information
Showing
798 changed files
with
13,649 additions
and
54,767 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| cff-version: 1.2.0 | ||
| message: "If you use this software, please cite it as below." | ||
| authors: | ||
| - family-names: "Kruchten" | ||
| given-names: "Nicolas" | ||
| orcid: https://orcid.org/0000-0002-8416-789X | ||
| - family-names: "Seier" | ||
| given-names: "Andrew" | ||
| - family-names: "Parmer" | ||
| given-names: "Chris" | ||
| title: "An interactive, open-source, and browser-based graphing library for Python" | ||
| version: 5.24.1 | ||
| doi: 10.5281/zenodo.14503524 | ||
| date-released: 2024-09-12 | ||
| url: "https://github.com/plotly/plotly.py" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,12 +37,9 @@ | |
| </a> | ||
| </div> | ||
|
|
||
|
|
||
| ## Quickstart | ||
|
|
||
| `pip install plotly==5.24.1` | ||
|
|
||
| Inside [Jupyter](https://jupyter.org/install) (installable with `pip install "jupyterlab>=3" "ipywidgets>=7.6"`): | ||
| `pip install plotly==6.0.0rc0` | ||
|
|
||
| ```python | ||
| import plotly.express as px | ||
|
|
@@ -52,7 +49,6 @@ fig.show() | |
|
|
||
| See the [Python documentation](https://plotly.com/python/) for more examples. | ||
|
|
||
|
|
||
| ## Overview | ||
|
|
||
| [plotly.py](https://plotly.com/python/) is an interactive, open-source, and browser-based graphing library for Python :sparkles: | ||
|
|
@@ -74,63 +70,37 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is | |
| - [Contributing to plotly](https://github.com/plotly/plotly.py/blob/master/contributing.md) | ||
| - [Changelog](https://github.com/plotly/plotly.py/blob/master/CHANGELOG.md) | ||
| - [Code of Conduct](https://github.com/plotly/plotly.py/blob/master/CODE_OF_CONDUCT.md) | ||
| - [Version 4 Migration Guide](https://plotly.com/python/v4-migration/) | ||
| - [New! Announcing Dash 1.0](https://medium.com/plotly/welcoming-dash-1-0-0-f3af4b84bae) | ||
| - [Community forum](https://community.plotly.com) | ||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| plotly.py may be installed using pip... | ||
| plotly.py may be installed using pip | ||
|
|
||
| ``` | ||
| pip install plotly==5.24.1 | ||
| pip install plotly==6.0.0rc0 | ||
| ``` | ||
|
|
||
| or conda. | ||
|
|
||
| ``` | ||
| conda install -c plotly plotly=5.24.1 | ||
| ``` | ||
|
|
||
| ### JupyterLab Support | ||
|
|
||
| For use in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `ipywidgets` | ||
| packages using `pip`: | ||
|
|
||
| ``` | ||
| pip install "jupyterlab>=3" "ipywidgets>=7.6" | ||
| ``` | ||
|
|
||
| or `conda`: | ||
|
|
||
| ``` | ||
| conda install "jupyterlab>=3" "ipywidgets>=7.6" | ||
| ``` | ||
|
|
||
| The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**, run the following commands to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed): | ||
|
|
||
| ``` | ||
| # JupyterLab 2.x renderer support | ||
| jupyter labextension install [email protected] @jupyter-widgets/jupyterlab-manager | ||
| conda install -c plotly plotly=6.0.0rc0 | ||
| ``` | ||
|
|
||
| Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab. | ||
| ### Jupyter Widget Support | ||
|
|
||
| ### Jupyter Notebook Support | ||
|
|
||
| For use in the Jupyter Notebook, install the `notebook` and `ipywidgets` | ||
| For use as a Jupyter widget, install `jupyter` and `anywidget` | ||
| packages using `pip`: | ||
|
|
||
| ``` | ||
| pip install "notebook>=5.3" "ipywidgets>=7.5" | ||
| pip install jupyter anywidget | ||
| ``` | ||
|
|
||
| or `conda`: | ||
|
|
||
| ``` | ||
| conda install "notebook>=5.3" "ipywidgets>=7.5" | ||
| conda install jupyter anywidget | ||
| ``` | ||
|
|
||
| ### Static Image Export | ||
|
|
@@ -143,41 +113,18 @@ command line utility (legacy as of `plotly` version 4.9). | |
| #### Kaleido | ||
|
|
||
| The [`kaleido`](https://github.com/plotly/Kaleido) package has no dependencies and can be installed | ||
| using pip... | ||
| using pip | ||
|
|
||
| ``` | ||
| pip install -U kaleido | ||
| ``` | ||
|
|
||
| or conda. | ||
| or conda | ||
|
|
||
| ``` | ||
| conda install -c conda-forge python-kaleido | ||
| ``` | ||
|
|
||
| #### Orca | ||
|
|
||
| While Kaleido is now the recommended image export approach because it is easier to install | ||
| and more widely compatible, [static image export](https://plotly.com/python/static-image-export/) | ||
| can also be supported | ||
| by the legacy [orca](https://github.com/plotly/orca) command line utility and the | ||
| [`psutil`](https://github.com/giampaolo/psutil) Python package. | ||
|
|
||
| These dependencies can both be installed using conda: | ||
|
|
||
| ``` | ||
| conda install -c plotly plotly-orca==1.3.1 psutil | ||
| ``` | ||
|
|
||
| Or, `psutil` can be installed using pip... | ||
|
|
||
| ``` | ||
| pip install psutil | ||
| ``` | ||
|
|
||
| and orca can be installed according to the instructions in the [orca README](https://github.com/plotly/orca). | ||
|
|
||
|
|
||
| ### Extended Geo Support | ||
|
|
||
| Some plotly.py features rely on fairly large geographic shape files. The county | ||
|
|
@@ -194,12 +141,6 @@ or conda | |
| conda install -c plotly plotly-geo=1.0.0 | ||
| ``` | ||
|
|
||
| ## Migration | ||
|
|
||
| If you're migrating from plotly.py v3 to v4, please check out the [Version 4 migration guide](https://plotly.com/python/v4-migration/) | ||
|
|
||
| If you're migrating from plotly.py v2 to v3, please check out the [Version 3 migration guide](https://github.com/plotly/plotly.py/blob/master/migration-guide.md) | ||
|
|
||
| ## Copyright and Licenses | ||
|
|
||
| Code and documentation copyright 2019 Plotly, Inc. | ||
|
|
||
Oops, something went wrong.