twython/docs/index.rst
Mike Helmick dd61841481 Fork Me badge, more docs
[ci skip]
2013-06-07 20:54:52 -04:00

47 lines
1 KiB
ReStructuredText

.. 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://dev.twitter.com/docs/api/1.1>`_.
- 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
-----
.. toctree::
:maxdepth: 4
usage/install
usage/starting_out
usage/basic_usage
usage/advanced_usage
usage/streaming_api
Twython API Documentation
-------------------------
.. toctree::
:maxdepth: 2
api