###################################
API Reference
###################################

.. module:: twixl.collections.twitter

This part of the documentation covers all the interfaces of twitter.

Main interface
-------------------

All of the twinls' functionality can be accessed by the following functions and classes.

.. autofunction:: search
.. autofunction:: tweet_metrics
.. autoenum:: dataset
    :members:
.. autoclass:: Query
	:inherited-members:
.. autofunction:: API


Plotting functons
-------------------

This section of the documentation covers all the plotting functions.

.. module:: twixl.collections.twitter.plotting

.. autofunction:: plot_tweet_frequencies
.. autofunction:: plot_word_cloud


Exceptions
-------------------

This section of the documentation covers all the exceptions.

.. module:: twixl.collections.twitter.exceptions

.. autoexception:: QueryFailed
.. autoexception:: QueryCanceled
.. autoexception:: QueryTimeout

Lower-Level Classes
-------------------

.. module:: twixl.collections.twitter
    :noindex:

.. autoclass:: SearchResults
    :inherited-members:
.. autoclass:: TweetMetrics
    :inherited-members: