def current():
"""
Retrieve information on the logged-in user from Plotly.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, route='current')
return request('get', url)
def create(body):
"""
Create a new folder.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
return request("post", url, json=body)
def create(body):
"""
Generate an image (which does not get saved on Plotly).
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
return request('post', url, json=body)
def restore(fid):
"""
Restore a trashed plot from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='restore')
return request('post', url)
def destroy(fid):
"""
Permanently delete a grid file from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
return request("delete", url)
def trash(fid):
"""
Soft-delete a plot from Plotly. (Can be undone with 'restore').
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="trash")
return request("post", url)
def permanent_delete(fid, params=None):
"""
Permanently delete a trashed plot file from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='permanent_delete')
return request('delete', url, params=params)
def restore(fid):
"""
Restore a trashed plot from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="restore")
return request("post", url)
def permanent_delete(fid, params=None):
"""
Permanently delete a trashed plot file from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="permanent_delete")
return request("delete", url, params=params)
def create(body):
"""
Generate an image (which does not get saved on Plotly).
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
return request("post", url, json=body)
def trash(fid):
"""
Soft-delete a plot from Plotly. (Can be undone with 'restore').
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='trash')
return request('post', url)
def create(body):
"""
Create a new plot.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
return request('post', url, json=body)
def retrieve(sha1, **kwargs):
"""
Retrieve the most up-to-date copy of the plot-schema wrt the given hash.
:param (str) sha1: The last-known hash of the plot-schema (or '').
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
params = make_params(sha1=sha1)
return request('get', url, params=params, **kwargs)
def retrieve(sha1, **kwargs):
"""
Retrieve the most up-to-date copy of the plot-schema wrt the given hash.
:param (str) sha1: The last-known hash of the plot-schema (or '').
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
params = make_params(sha1=sha1)
return request("get", url, params=params, **kwargs)
def row(fid, body):
"""
Append rows to a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='row')
return request('post', url, json=body)
def update(fid, body):
"""
Update a folder from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
return request("put", url, json=body)
def col_create(fid, body):
"""
Create a new column (or columns) inside a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='col')
return request('post', url, json=body)
def update(fid, body):
"""
Update a plot from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
return request('put', url, json=body)
def col_delete(fid, uid):
"""
Permanently delete a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='col')
params = make_params(uid=uid)
return request('delete', url, params=params)
def retrieve(fid, share_key=None):
"""
Retrieve a folder from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
params = make_params(share_key=share_key)
return request("get", url, params=params)
def retrieve(fid, share_key=None):
"""
Retrieve a plot from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
params = make_params(share_key=share_key)
return request('get', url, params=params)
def content(fid, share_key=None):
"""
Retrieve full content for the grid (normal retrieve only yields preview)
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='content')
params = make_params(share_key=share_key)
return request('get', url, params=params)
def permanent_delete(fid):
"""
Permanently delete a trashed folder file from Plotly. See 'trash'.
This action is recursively done on files inside the folder.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='permanent_delete')
return request('delete', url)
def permanent_delete(fid):
"""
Permanently delete a trashed folder file from Plotly. See 'trash'.
This action is recursively done on files inside the folder.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="permanent_delete")
return request("delete", url)
def trash(fid):
"""
Soft-delete a folder from Plotly. (Can be undone with 'restore').
This action is recursively done on files inside the folder.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='trash')
return request('post', url)
def col_update(fid, uid, body):
"""
Update a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='col')
params = make_params(uid=uid)
return request('put', url, json=body, params=params)
def lookup(path, parent=None, user=None, exists=None):
"""
Retrieve a folder file from Plotly without needing a fid.
:param (str) path: The '/'-delimited path specifying the file location.
:param (int) parent: Parent id, an integer, which the path is relative to.
:param (str) user: The username to target files for. Defaults to requestor.
:param (bool) exists: If True, don't return the full file, just a flag.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, route="lookup")
params = make_params(path=path, parent=parent, user=user, exists=exists)
return request("get", url, params=params)
def lookup(path, parent=None, user=None, exists=None):
"""
Retrieve a plot file from Plotly without needing a fid.
:param (str) path: The '/'-delimited path specifying the file location.
:param (int) parent: Parent id, an integer, which the path is relative to.
:param (str) user: The username to target files for. Defaults to requestor.
:param (bool) exists: If True, don't return the full file, just a flag.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, route='lookup')
params = make_params(path=path, parent=parent, user=user, exists=exists)
return request('get', url, params=params)
def content(fid, share_key=None, inline_data=None, map_data=None):
"""
Retrieve the *figure* for a Plotly plot file.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:param (bool) inline_data: If True, include the data arrays with the plot.
:param (str) map_data: Currently only accepts 'unreadable' to return a
mapping of grid-fid: grid. This is useful if you
want to maintain structure between the plot and
referenced grids when you have READ access to the
plot, but you don't have READ access to the
underlying grids.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='content')
params = make_params(share_key=share_key, inline_data=inline_data,
map_data=map_data)
return request('get', url, params=params)
def content(fid, share_key=None, inline_data=None, map_data=None):
"""
Retrieve the *figure* for a Plotly plot file.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:param (bool) inline_data: If True, include the data arrays with the plot.
:param (str) map_data: Currently only accepts 'unreadable' to return a
mapping of grid-fid: grid. This is useful if you
want to maintain structure between the plot and
referenced grids when you have READ access to the
plot, but you don't have READ access to the
underlying grids.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="content")
params = make_params(share_key=share_key,
inline_data=inline_data,
map_data=map_data)
return request("get", url, params=params)
def test_build_url_route(self):
url = utils.build_url('cats', route='about')
self.assertEqual(
url, '{}/v2/cats/about'.format(self.plotly_api_domain)
)
def test_build_url_id_route(self):
url = utils.build_url('cats', id='MsKitty', route='de-claw')
self.assertEqual(
url, '{}/v2/cats/MsKitty/de-claw'.format(self.plotly_api_domain)
)
def schema():
"""Retrieve the dashboard schema."""
url = build_url(RESOURCE, route="schema")
return request("get", url)
def create(body):
"""Create a presentation."""
url = build_url(RESOURCE)
return request('post', url, json=body)
def retrieve(fid):
"""Retrieve a presentation from Plotly."""
url = build_url(RESOURCE, id=fid)
return request('get', url)
def test_build_url_id_route(self):
url = utils.build_url('cats', id='MsKitty', route='de-claw')
self.assertEqual(
url, '{}/v2/cats/MsKitty/de-claw'.format(self.plotly_api_domain))
def test_build_url_id(self):
url = utils.build_url('cats', id='MsKitty')
self.assertEqual(url,
'{}/v2/cats/MsKitty'.format(self.plotly_api_domain))
def update(fid, content):
"""Completely update the writable."""
url = build_url(RESOURCE, id=fid)
return request('put', url, json=content)
def schema():
"""Retrieve the dashboard schema."""
url = build_url(RESOURCE, route='schema')
return request('get', url)
def create(body):
"""Create a dashboard."""
url = build_url(RESOURCE)
return request("post", url, json=body)
def list():
"""Returns the list of all users' dashboards."""
url = build_url(RESOURCE)
return request("get", url)
def test_build_url_id(self):
url = utils.build_url('cats', id='MsKitty')
self.assertEqual(
url, '{}/v2/cats/MsKitty'.format(self.plotly_api_domain)
)
def test_build_url(self):
url = utils.build_url('cats')
self.assertEqual(url, '{}/v2/cats'.format(self.plotly_api_domain))
def retrieve(fid):
"""Retrieve a dashboard from Plotly."""
url = build_url(RESOURCE, id=fid)
return request('get', url)
def test_build_url_route(self):
url = utils.build_url('cats', route='about')
self.assertEqual(url,
'{}/v2/cats/about'.format(self.plotly_api_domain))
def list():
"""Returns the list of all users' dashboards."""
url = build_url(RESOURCE)
return request('get', url)
def test_build_url(self):
url = utils.build_url('cats')
self.assertEqual(url, '{}/v2/cats'.format(self.plotly_api_domain))
def create(body):
"""Create a dashboard."""
url = build_url(RESOURCE)
return request('post', url, json=body)
def list():
"""Returns the list of all users' presentations."""
url = build_url(RESOURCE)
return request('get', url)
def test_build_url_id_route(self):
url = utils.build_url("cats", id="MsKitty", route="de-claw")
self.assertEqual(
url, "{}/v2/cats/MsKitty/de-claw".format(self.plotly_api_domain))
def retrieve(fid):
"""Retrieve a dashboard from Plotly."""
url = build_url(RESOURCE, id=fid)
return request("get", url)
def update(fid, content):
"""Completely update the writable."""
url = build_url(RESOURCE, id=fid)
return request("put", url, json=content)