.. Twython documentation master file, created by
   sphinx-quickstart on Thu May 30 22:31:25 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Twython
=======

    | Actively maintained, pure Python wrapper for the Twitter API. Supports both normal and streaming Twitter APIs


Features
--------
- Query data for:
   - User information
   - Twitter lists
   - Timelines
   - Direct Messages
   - and anything found in `the Twitter API docs <https://developer.twitter.com/en/docs>`_.
- Image Uploading:
   - Update user status with an image
   - Change user avatar
   - Change user background image
   - Change user banner image
- OAuth 2 Application Only (read-only) Support
- Support for Twitter's Streaming API
- Seamless Python 3 support!

Usage
-----

..
   I know it isn't necessary to start a new tree for every section,
   but I think it looks a bit cleaner that way!

.. toctree::
   :maxdepth: 4

   usage/install

.. toctree::
   :maxdepth: 4

   usage/starting_out

.. toctree::
   :maxdepth: 4

   usage/basic_usage

.. toctree::
   :maxdepth: 4

   usage/advanced_usage

.. toctree::
   :maxdepth: 4

   usage/streaming_api

.. toctree::
   :maxdepth: 2

   usage/special_functions

Twython API Documentation
-------------------------

.. toctree::
   :maxdepth: 2

   api