]> jfr.im git - z_archive/twitter.git/blame_incremental - twitter/__init__.py
Improve documentation.
[z_archive/twitter.git] / twitter / __init__.py
... / ...
CommitLineData
1"""
2The minimalist yet fully featured Twitter API and Python toolset.
3
4The Twitter and TwitterStream classes are the key to building your own
5Twitter-enabled applications.
6
7"""
8
9from .api import Twitter, TwitterError, TwitterHTTPError, TwitterResponse
10from .auth import NoAuth, UserPassAuth
11from .oauth import OAuth, read_token_file, write_token_file
12from .stream import TwitterStream
13
14
15# Who needs Sphinx? Not me!
16
17__doc__ += """
18The Twitter class
19=================
20"""
21__doc__ += Twitter.__doc__
22
23__doc__ += """
24The TwitterStream class
25=======================
26"""
27__doc__ += TwitterStream.__doc__
28
29
30__doc__ += """
31Twitter Response Objects
32========================
33"""
34__doc__ += TwitterResponse.__doc__
35
36
37__doc__ += """
38Authentication Objects
39======================
40
41You can authenticate with Twitter in three ways: NoAuth, OAuth, or
42UserPassAuth. Get help() on these classes to learn how to use them.
43
44
45Other things
46============
47
48read_token_file and write_token_file are utility methods to read and
49write OAuth token and secret key values. The values are stored as
50strings in the file. Not terribly exciting.
51"""
52
53__all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError",
54 "TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth",
55 "read_token_file", "write_token_file"]