SPy Workbooks
=============

.. currentmodule:: seeq.spy.workbooks

Constants
---------

.. data:: seeq.spy.workbooks.ALL

   Top-level workbook directory that can be used in a workbook path argument

.. data:: seeq.spy.workbooks.CORPORATE

   Top-level workbook directory that can be used in a workbook path argument

.. data:: seeq.spy.workbooks.FORCE_ME_AS_OWNER

   Use as input for ``owner`` argument of ``spy.workbooks.push`` to assign ownership of the pushed content to the
   logged-in user

.. data:: seeq.spy.workbooks.MY_FOLDER

   Top-level workbook directory that can be used in a workbook path argument

.. data:: seeq.spy.workbooks.ORIGINAL_OWNER

   Use as input for ``owner`` argument of ``spy.workbooks.push`` to assign ownership of the pushed content to the
   original owner of the pulled content

.. data:: seeq.spy.workbooks.PUBLIC

   Top-level workbook directory that can be used in a workbook path argument

.. data:: seeq.spy.workbooks.SHARED

   Top-level workbook directory that can be used in a workbook path argument

.. data:: seeq.spy.workbooks.USERS

   Top-level workbook directory that can be used in a workbook path argument


Classes
-------

.. autoclass:: seeq.spy.workbooks.Analysis
   :members:
.. autoclass:: seeq.spy.workbooks.AnalysisWorksheet
   :members:
.. autoclass:: seeq.spy.workbooks.Annotation
   :members:
.. autoclass:: seeq.spy.workbooks.AssetSelection
   :members:
.. autoclass:: seeq.spy.workbooks.Content
   :members:
.. autoclass:: seeq.spy.workbooks.DateRange
   :members:
.. autoclass:: seeq.spy.workbooks.Item
   :members:
.. autoclass:: seeq.spy.workbooks.Journal
   :members:
.. autoclass:: seeq.spy.workbooks.Report
   :members:
.. autoclass:: seeq.spy.workbooks.Topic
   :members:
.. autoclass:: seeq.spy.workbooks.TopicDocument
   :members:
.. autoclass:: seeq.spy.workbooks.Workbook
   :members:
.. autoclass:: seeq.spy.workbooks.Worksheet
   :members:


Functions
---------

.. autofunction:: seeq.spy.workbooks.load
.. autofunction:: seeq.spy.workbooks.pull
.. autofunction:: seeq.spy.workbooks.push
.. autofunction:: seeq.spy.workbooks.save
.. autofunction:: seeq.spy.workbooks.search