X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/249508919a85673ed16c9661815697aada5462b5..678d3eb9e13ab58aa3283e3f0c48b6dea1d96095:/twitter/__init__.py diff --git a/twitter/__init__.py b/twitter/__init__.py index d48fd9b..151f346 100644 --- a/twitter/__init__.py +++ b/twitter/__init__.py @@ -6,50 +6,53 @@ 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 +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__ += Twitter.__doc__ +__doc__ += dedent(Twitter.__doc__) __doc__ += """ The TwitterStream class -======================= +----------------------- """ -__doc__ += TwitterStream.__doc__ +__doc__ += dedent(TwitterStream.__doc__) __doc__ += """ Twitter Response Objects -======================== +------------------------ """ -__doc__ += TwitterResponse.__doc__ +__doc__ += dedent(TwitterResponse.__doc__) __doc__ += """ -Authentication Objects -====================== +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. -Other things -============ -read_token_file and write_token_file are utility methods to read and -write OAuth token and secret key values. The values are stored as -strings in the file. Not terribly exciting. +Working with OAuth +------------------ """ +__doc__ += dedent(oauth_doc) + __all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError", "TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth", - "read_token_file", "write_token_file"] + "read_token_file", "write_token_file", "oauth_dance"]