|
| 1 | +======= |
| 2 | +plotly: |
| 3 | +======= |
| 4 | +-------------------------- |
| 5 | +It's all about the graphs. |
| 6 | +-------------------------- |
| 7 | + |
| 8 | +The Nutshell |
| 9 | +~~~~~~~~~~~~ |
| 10 | + |
| 11 | +Use this package to make collaborative, interactive, |
| 12 | +publication-quality graphs from Python. |
| 13 | + |
| 14 | +Here's how you import:: |
| 15 | + |
| 16 | + import plotly.plotly as py # for sending things to plotly |
| 17 | + import plotly.tools as tls # for mpl, config, etc. |
| 18 | + from plotly.graph_objs import * # __all__ is safely defined |
| 19 | + |
| 20 | +Here's how you sign in:: |
| 21 | + |
| 22 | + py.sign_in('PythonAPI', 'ubpiol2cve') # get your own at https://plot.ly/ |
| 23 | + |
| 24 | +Here's how you plot data or a figure:: |
| 25 | + |
| 26 | + py.plot(data_or_figure_here) |
| 27 | + |
| 28 | +Here's what you get: |
| 29 | + |
| 30 | +* an account on plotly |
| 31 | +* a unique url for your data/figures |
| 32 | +* an interactive web-application to edit your figure or make new figures |
| 33 | +* a platform on which to share your data/figures with the world |
| 34 | + |
| 35 | +You can also convert supported matplotlib figures:: |
| 36 | + |
| 37 | + py.plot_mpl(mplfig) |
| 38 | + |
| 39 | +Stop fighting with your figures; start designing them. Check out our |
| 40 | +Quickstart_ to get going. |
| 41 | + |
| 42 | + |
| 43 | +About |
| 44 | +~~~~~ |
| 45 | + |
| 46 | +Plotly_ is an online collaborative data analysis and graphing tool. The |
| 47 | +Python API allows you to access all of Plotly's functionality from Python. |
| 48 | +Plotly figures are shared, tracked, and edited all online and the data is |
| 49 | +always accessible from the graph. |
| 50 | + |
| 51 | +That's it. Find out more, sign up, and start sharing by visiting us at |
| 52 | +https://plot.ly. |
| 53 | + |
| 54 | +Install via pip |
| 55 | +~~~~~~~~~~~~~~~ |
| 56 | + |
| 57 | +Assuming you have already installed pip, you can simply enter the following |
| 58 | +in a terminal program:: |
| 59 | + |
| 60 | + $ pip install plotly |
| 61 | + |
| 62 | +Contributing! |
| 63 | +~~~~~~~~~~~~~ |
| 64 | + |
| 65 | +If you want to contribute to making Plotly's Python API experience better, |
| 66 | +head to our `GitHub repo`_. Instructions for installing from here, |
| 67 | +updating the included submodules, and contributing are detailed there! |
| 68 | + |
| 69 | +Plotly, matplotlib, and mpld3 |
| 70 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 71 | + |
| 72 | +The matplotlylib sub-package allows you to convert matplotlib figures to |
| 73 | +plotly figures, with a one-liner:: |
| 74 | + |
| 75 | + py.plot_mpl(fig) |
| 76 | + |
| 77 | +Checkout the `Plotly and mpld3`_ IPython notebook for more infomataion. |
| 78 | + |
| 79 | +Introduction to working with out API |
| 80 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 81 | + |
| 82 | +Checkout the `Plotly and Python`_ IPython notebook to get a more in depth |
| 83 | +exposition of our Python API. |
| 84 | + |
| 85 | +Plotly's *guide book* |
| 86 | +~~~~~~~~~~~~~~~~~~~~~ |
| 87 | + |
| 88 | +Still here? Don't worry, we've got more documentation for you. Checkout a |
| 89 | +*highly* complete `set of notebooks`_ for walk-throughs on all the features |
| 90 | +we offer! |
| 91 | + |
| 92 | +Details |
| 93 | +~~~~~~~ |
| 94 | + |
| 95 | +The plotly package depends on requests, which will be installed by pip for you. |
| 96 | + |
| 97 | +To use the matplotlylib subpackage, you'll also need to have matplotlib 1.3.1 |
| 98 | +properly installed on your machine. |
| 99 | + |
| 100 | +The matpotlylib package is based on the mplexporter framework for crawling |
| 101 | +and exporting matplotlib images. |
| 102 | + |
| 103 | +Created by: Plotly_, `@plotlygraphs`_, `feedback@plot.ly`_ |
| 104 | + |
| 105 | +License: MIT |
| 106 | + |
| 107 | +.. _Plotly: https://plot.ly |
| 108 | +.. _Quickstart: https://plot.ly |
| 109 | +.. _GitHub repo: https://github.com/plotly/python-api |
| 110 | +.. _Plotly and mpld3: http://nbviewer.ipython.org/github/plotly/python-api/blob/1.0/notebooks/Plotly%20and%20mpld3.ipynb |
| 111 | +.. _Plotly and Python: http://nbviewer.ipython.org/github/plotly/python-api/blob/1.0/notebooks/Plotly%20and%20Python.ipynb |
| 112 | +.. _set of notebooks: https://plot.ly |
| 113 | +.. _plotly profile: https://plot.ly/~mpld3/ |
| 114 | +.. _@plotlygraphs: https://twitter.com/plotlygraphs |
| 115 | +.. _feedback@plot.ly: feedback@plot.ly |
0 commit comments