The SPy Module Core
===================

.. currentmodule:: seeq.spy

Constants
---------

.. data:: seeq.spy.DEFAULT_WORKBOOK_PATH
   :value: 'Data Lab >> Data Lab Analysis'

   The path of the default workbook that ``spy.push`` will push data to

.. data:: seeq.spy.GLOBALS_AND_ALL_WORKBOOKS

   Use as input for the ``workbook`` parameter of ``spy.search`` to query all items regardless of scope

.. data:: seeq.spy.GLOBALS_ONLY

   Use as input for the ``workbook`` parameter of ``spy.search`` to query only globally scoped items


Classes
-------

.. autoclass:: seeq.spy.Session
   :members:
.. autoclass:: seeq.spy.Status
   :members:


Global Attributes
-----------------

.. autodata:: seeq.spy.client
   :no-value:
.. autodata:: seeq.spy.options
   :no-value:
.. autodata:: seeq.spy.server_version
   :no-value:
.. autodata:: seeq.spy.session
   :no-value:
.. autodata:: seeq.spy.user
   :no-value:


Exception Types
---------------

.. automodule:: seeq.spy.errors
   :members:
   :show-inheritance:

.. py:exception:: seeq.spy.errors.ApiException

   Raised when a call to the Seeq Server API fails


The Core SPy Functions
----------------------

.. autofunction:: seeq.spy.login
.. autofunction:: seeq.spy.logout
.. autofunction:: seeq.spy.plot
.. autofunction:: seeq.spy.pull
.. autofunction:: seeq.spy.push
.. autofunction:: seeq.spy.search
.. autofunction:: seeq.spy.swap