#######
Sisense
#######

Overview
========

`Sisense for Cloud Data Teams <https://app.periscopedata.com/app>`__ is a business intelligence software
formerly known as `Periscope Data <https://www.sisense.com/blog/periscope-data-is-now-sisense-for-cloud-data-teams/>`__,
with functionality including dashboards, data warehousing, data mining, and predictive analytics.

This Parsons integration with the `Sisense REST API v1.0 <https://developer.sisense.com/reference/rest/v1.html>`__ supports
fetching, posting, and deleting shared dashboards.

.. admonition:: Authentication

   Your site name and an authentication token are required to use the
   :class:`~parsons.sisense.sisense.Sisense` class. To obtain a token, log in to
   the Sisense Web Application and follow the instructions in the
   `Sisense REST API Authentication documentation <https://developer.sisense.com/guides/restApi/v1/#/authentication>`__.
   Be sure to select version ``1.0`` of the API.

Quickstart
==========

To instantiate the :class:`~parsons.sisense.sisense.Sisense` class, you can either store your
Sisense credentials as environmental variables (``SISENSE_SITE_NAME`` and ``SISENSE_API_KEY``)
or pass them as keyword arguments.

.. code-block:: python
   :caption: Pass authentication credentials with environmental variables

   from parsons import Sisense
   sisense = Sisense()

.. code-block:: python
   :caption: Pass authentication credentials as arguments

   from parsons import Sisense
   sisense = Sisense(site_name='my_site_name', api_key='my_api_key')

You can then call various endpoints:

.. code-block:: python
   :caption: Get all the shares for a dashboard

   sisense.list_shared_dashboards(dashboard_id='1234')

.. code-block:: python
   :caption: Publish a dashboard

   sisense.publish_shared_dashboard(dashboard_id='1234')

.. code-block:: python
   :caption: Publish a chart

   sisense.publish_shared_dashboard(dashboard_id='1234', chart_id='567')

.. code-block:: python
   :caption: Delete a dashboard

   sisense.delete_shared_dashboard(dashboard_id='1234')

API
====

.. autoclass:: parsons.sisense.sisense.Sisense
   :inherited-members:
   :members: