This package provides wrapper functions for Plotly's HTTP API.
At the time of writing that API is largely undocumented so the work here is based on the Pyhton API.
In order to use this package you require API credentials from Plotly. These may be stored in:
.plotly_credentials.json
plotly_credentials.json
$HOME/plotly_credentials.json
$HOME/.plotly_credentials.json
/etc/plotly/.plotly_credentials.json
/etc/plotly/plotly_credentials.json
- Environment variables named
PLOTLY_USERNAME
andPLOTLY_APIKEY
If more than one of these are available, the highest one in the list takes preference.
The .json
files should contain the following:
{"Username":"yourname","Apikey":"yourkey"}
An example program is provided in this repository.
This is a work in process.
One important thing to be aware of is that the plotly API always returns 200,
so checking for an error from the request is not suitable, rather look at the
error
field in the response.