X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/aec689591a6382c274aeedcd4f4a89762f2f1f17..bb2a70ee2fcd56b2c2a6d6a4d606353024be0b7e:/twitter/__init__.py diff --git a/twitter/__init__.py b/twitter/__init__.py index 25a4b5d..ec19917 100644 --- a/twitter/__init__.py +++ b/twitter/__init__.py @@ -1,9 +1,58 @@ """ The minimalist yet fully featured Twitter API and Python toolset. -For building your own applications, look at the `Twitter` class. +The Twitter and TwitterStream classes are the key to building your own +Twitter-enabled applications. + +""" + +from textwrap import dedent + +from .api import Twitter, TwitterError, TwitterHTTPError, TwitterResponse +from .auth import NoAuth, UserPassAuth +from .oauth import (OAuth, read_token_file, write_token_file, + __doc__ as oauth_doc) +from .stream import TwitterStream +from .oauth_dance import oauth_dance + +# Who needs Sphinx? Not me! + +__doc__ += """ +The Twitter class +================= +""" +__doc__ += dedent(Twitter.__doc__) + +__doc__ += """ +The TwitterStream class +======================= """ +__doc__ += dedent(TwitterStream.__doc__) + + +__doc__ += """ +Twitter Response Objects +======================== +""" +__doc__ += dedent(TwitterResponse.__doc__) + + +__doc__ += """ +Authentication +============== + +You can authenticate with Twitter in three ways: NoAuth, OAuth, or +UserPassAuth. Get help() on these classes to learn how to use them. + +OAuth is probably the most useful. + + +Working with OAuth +================== +""" + +__doc__ += dedent(oauth_doc) -from api import * -from auth import NoAuth -from oauth import OAuth +__all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError", + "TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth", + "read_token_file", "write_token_file", "oauth_dance"]