twython/docs/api.rst
Mike Helmick 55641a1966 Begin docs
[ci skip]
2013-06-06 13:41:56 -04:00

43 lines
No EOL
897 B
ReStructuredText

.. _api:
Developer Interface
===================
.. module:: twython
This page of the documentation will cover all methods and classes available to the developer.
Twython, currently, has two main interfaces:
- Twitter's Core API (updating statuses, getting timelines, direct messaging, etc)
- Twitter's Streaming API
Core Interface
--------------
.. autoclass:: Twython
:special-members: __init__
:inherited-members:
Streaming Interface
-------------------
.. autoclass:: TwythonStreamer
:special-members: __init__
:inherited-members:
Streaming Types
~~~~~~~~~~~~~~~
.. autoclass:: twython.streaming.types.TwythonStreamerTypes
:inherited-members:
.. autoclass:: twython.streaming.types.TwythonStreamerTypesStatuses
:inherited-members:
Exceptions
----------
.. autoexception:: TwythonError
.. autoexception:: TwythonAuthError
.. autoexception:: TwythonRateLimitError