|
| 1 | +Metadata-Version: 2.1 |
| 2 | +Name: plotly |
| 3 | +Version: 5.15.0 |
| 4 | +Summary: An open-source, interactive data visualization library for Python |
| 5 | +Home-page: https://plotly.com/python/ |
| 6 | +Author: Chris P |
| 7 | + |
| 8 | +Maintainer: Nicolas Kruchten |
| 9 | +Maintainer-email: [email protected] |
| 10 | +License: MIT |
| 11 | +Project-URL: Github, https://github.com/plotly/plotly.py |
| 12 | +Classifier: Development Status :: 5 - Production/Stable |
| 13 | +Classifier: Programming Language :: Python :: 3.6 |
| 14 | +Classifier: Programming Language :: Python :: 3.7 |
| 15 | +Classifier: Programming Language :: Python :: 3.8 |
| 16 | +Classifier: Programming Language :: Python :: 3.9 |
| 17 | +Classifier: Programming Language :: Python :: 3.10 |
| 18 | +Classifier: Programming Language :: Python :: 3.11 |
| 19 | +Classifier: Topic :: Scientific/Engineering :: Visualization |
| 20 | +Classifier: License :: OSI Approved :: MIT License |
| 21 | +Requires-Python: >=3.6 |
| 22 | +Description-Content-Type: text/markdown |
| 23 | +License-File: LICENSE.txt |
| 24 | + |
| 25 | +# plotly.py |
| 26 | + |
| 27 | +<table> |
| 28 | + <tr> |
| 29 | + <td>Latest Release</td> |
| 30 | + <td> |
| 31 | + <a href="https://pypi.org/project/plotly/"/> |
| 32 | + <img src="https://badge.fury.io/py/plotly.svg"/> |
| 33 | + </td> |
| 34 | + </tr> |
| 35 | + <tr> |
| 36 | + <td>User forum</td> |
| 37 | + <td> |
| 38 | + <a href="https://community.plotly.com/"/> |
| 39 | + <img src="https://img.shields.io/badge/help_forum-discourse-blue.svg"/> |
| 40 | + </td> |
| 41 | + </tr> |
| 42 | + <tr> |
| 43 | + <td>PyPI Downloads</td> |
| 44 | + <td> |
| 45 | + <a href="https://pepy.tech/project/plotly"/> |
| 46 | + <img src="https://pepy.tech/badge/plotly/month"/> |
| 47 | + </td> |
| 48 | + </tr> |
| 49 | + <tr> |
| 50 | + <td>License</td> |
| 51 | + <td> |
| 52 | + <a href="https://opensource.org/licenses/MIT"/> |
| 53 | + <img src="https://img.shields.io/badge/License-MIT-yellow.svg"/> |
| 54 | + </td> |
| 55 | + </tr> |
| 56 | +</table> |
| 57 | + |
| 58 | +## Quickstart |
| 59 | + |
| 60 | +`pip install plotly==5.15.0` |
| 61 | + |
| 62 | +Inside [Jupyter](https://jupyter.org/install) (installable with `pip install "jupyterlab>=3" "ipywidgets>=7.6"`): |
| 63 | + |
| 64 | +```python |
| 65 | +import plotly.express as px |
| 66 | +fig = px.bar(x=["a", "b", "c"], y=[1, 3, 2]) |
| 67 | +fig.show() |
| 68 | +``` |
| 69 | + |
| 70 | +See the [Python documentation](https://plotly.com/python/) for more examples. |
| 71 | + |
| 72 | + |
| 73 | +## Overview |
| 74 | + |
| 75 | +[plotly.py](https://plotly.com/python/) is an interactive, open-source, and browser-based graphing library for Python :sparkles: |
| 76 | + |
| 77 | +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. |
| 78 | + |
| 79 | +`plotly.py` is [MIT Licensed](https://github.com/plotly/plotly.py/blob/master/LICENSE.txt). Plotly graphs can be viewed in Jupyter notebooks, standalone HTML files, or integrated into [Dash applications](https://dash.plotly.com/). |
| 80 | + |
| 81 | +[Contact us](https://plotly.com/consulting-and-oem/) for consulting, dashboard development, application integration, and feature additions. |
| 82 | + |
| 83 | +<p align="center"> |
| 84 | + <a href="https://plotly.com/python/" target="_blank"> |
| 85 | + <img src="https://raw.githubusercontent.com/cldougl/plot_images/add_r_img/plotly_2017.png"> |
| 86 | +</a></p> |
| 87 | + |
| 88 | +--- |
| 89 | + |
| 90 | +- [Online Documentation](https://plotly.com/python/) |
| 91 | +- [Contributing to plotly](https://github.com/plotly/plotly.py/blob/master/contributing.md) |
| 92 | +- [Changelog](https://github.com/plotly/plotly.py/blob/master/CHANGELOG.md) |
| 93 | +- [Code of Conduct](https://github.com/plotly/plotly.py/blob/master/CODE_OF_CONDUCT.md) |
| 94 | +- [Version 4 Migration Guide](https://plotly.com/python/v4-migration/) |
| 95 | +- [New! Announcing Dash 1.0](https://medium.com/plotly/welcoming-dash-1-0-0-f3af4b84bae) |
| 96 | +- [Community forum](https://community.plotly.com) |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +## Installation |
| 101 | + |
| 102 | +plotly.py may be installed using pip... |
| 103 | + |
| 104 | +``` |
| 105 | +pip install plotly==5.15.0 |
| 106 | +``` |
| 107 | + |
| 108 | +or conda. |
| 109 | + |
| 110 | +``` |
| 111 | +conda install -c plotly plotly=5.15.0 |
| 112 | +``` |
| 113 | + |
| 114 | +### JupyterLab Support |
| 115 | + |
| 116 | +For use in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `ipywidgets` |
| 117 | +packages using `pip`: |
| 118 | + |
| 119 | +``` |
| 120 | +pip install "jupyterlab>=3" "ipywidgets>=7.6" |
| 121 | +``` |
| 122 | + |
| 123 | +or `conda`: |
| 124 | + |
| 125 | +``` |
| 126 | +conda install "jupyterlab>=3" "ipywidgets>=7.6" |
| 127 | +``` |
| 128 | + |
| 129 | +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): |
| 130 | + |
| 131 | +``` |
| 132 | +# JupyterLab 2.x renderer support |
| 133 | +jupyter labextension install [email protected] @jupyter-widgets/jupyterlab-manager |
| 134 | +``` |
| 135 | + |
| 136 | +Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab. |
| 137 | + |
| 138 | +### Jupyter Notebook Support |
| 139 | + |
| 140 | +For use in the Jupyter Notebook, install the `notebook` and `ipywidgets` |
| 141 | +packages using `pip`: |
| 142 | + |
| 143 | +``` |
| 144 | +pip install "notebook>=5.3" "ipywidgets>=7.5" |
| 145 | +``` |
| 146 | + |
| 147 | +or `conda`: |
| 148 | + |
| 149 | +``` |
| 150 | +conda install "notebook>=5.3" "ipywidgets>=7.5" |
| 151 | +``` |
| 152 | + |
| 153 | +### Static Image Export |
| 154 | + |
| 155 | +plotly.py supports [static image export](https://plotly.com/python/static-image-export/), |
| 156 | +using either the [`kaleido`](https://github.com/plotly/Kaleido) |
| 157 | +package (recommended, supported as of `plotly` version 4.9) or the [orca](https://github.com/plotly/orca) |
| 158 | +command line utility (legacy as of `plotly` version 4.9). |
| 159 | + |
| 160 | +#### Kaleido |
| 161 | + |
| 162 | +The [`kaleido`](https://github.com/plotly/Kaleido) package has no dependencies and can be installed |
| 163 | +using pip... |
| 164 | + |
| 165 | +``` |
| 166 | +pip install -U kaleido |
| 167 | +``` |
| 168 | + |
| 169 | +or conda. |
| 170 | + |
| 171 | +``` |
| 172 | +conda install -c conda-forge python-kaleido |
| 173 | +``` |
| 174 | + |
| 175 | +#### Orca |
| 176 | + |
| 177 | +While Kaleido is now the recommended image export approach because it is easier to install |
| 178 | +and more widely compatible, [static image export](https://plotly.com/python/static-image-export/) |
| 179 | +can also be supported |
| 180 | +by the legacy [orca](https://github.com/plotly/orca) command line utility and the |
| 181 | + [`psutil`](https://github.com/giampaolo/psutil) Python package. |
| 182 | + |
| 183 | +These dependencies can both be installed using conda: |
| 184 | + |
| 185 | +``` |
| 186 | +conda install -c plotly plotly-orca==1.3.1 psutil |
| 187 | +``` |
| 188 | + |
| 189 | +Or, `psutil` can be installed using pip... |
| 190 | + |
| 191 | +``` |
| 192 | +pip install psutil |
| 193 | +``` |
| 194 | + |
| 195 | +and orca can be installed according to the instructions in the [orca README](https://github.com/plotly/orca). |
| 196 | + |
| 197 | + |
| 198 | +### Extended Geo Support |
| 199 | + |
| 200 | +Some plotly.py features rely on fairly large geographic shape files. The county |
| 201 | +choropleth figure factory is one such example. These shape files are distributed as a |
| 202 | +separate `plotly-geo` package. This package can be installed using pip... |
| 203 | + |
| 204 | +``` |
| 205 | +pip install plotly-geo==1.0.0 |
| 206 | +``` |
| 207 | + |
| 208 | +or conda |
| 209 | + |
| 210 | +``` |
| 211 | +conda install -c plotly plotly-geo=1.0.0 |
| 212 | +``` |
| 213 | + |
| 214 | +## Migration |
| 215 | + |
| 216 | +If you're migrating from plotly.py v3 to v4, please check out the [Version 4 migration guide](https://plotly.com/python/v4-migration/) |
| 217 | + |
| 218 | +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) |
| 219 | + |
| 220 | +## Copyright and Licenses |
| 221 | + |
| 222 | +Code and documentation copyright 2019 Plotly, Inc. |
| 223 | + |
| 224 | +Code released under the [MIT license](https://github.com/plotly/plotly.py/blob/master/LICENSE.txt). |
| 225 | + |
| 226 | +Docs released under the [Creative Commons license](https://github.com/plotly/documentation/blob/source/LICENSE). |
0 commit comments