]>
Commit | Line | Data |
---|---|---|
1 | """ | |
2 | The minimalist yet fully featured Twitter API and Python toolset. | |
3 | ||
4 | The Twitter and TwitterStream classes are the key to building your own | |
5 | Twitter-enabled applications. | |
6 | ||
7 | """ | |
8 | ||
9 | from textwrap import dedent | |
10 | ||
11 | from .api import Twitter, TwitterError, TwitterHTTPError, TwitterResponse | |
12 | from .auth import NoAuth, UserPassAuth | |
13 | from .oauth import (OAuth, read_token_file, write_token_file, | |
14 | __doc__ as oauth_doc) | |
15 | from .oauth2 import OAuth2 | |
16 | from .stream import TwitterStream | |
17 | from .oauth_dance import oauth_dance | |
18 | ||
19 | # Who needs Sphinx? Not me! | |
20 | ||
21 | __doc__ += """ | |
22 | The Twitter class | |
23 | ----------------- | |
24 | """ | |
25 | __doc__ += dedent(Twitter.__doc__) | |
26 | ||
27 | __doc__ += """ | |
28 | The TwitterStream class | |
29 | ----------------------- | |
30 | """ | |
31 | __doc__ += dedent(TwitterStream.__doc__) | |
32 | ||
33 | ||
34 | __doc__ += """ | |
35 | Twitter Response Objects | |
36 | ------------------------ | |
37 | """ | |
38 | __doc__ += dedent(TwitterResponse.__doc__) | |
39 | ||
40 | ||
41 | __doc__ += """ | |
42 | Authentication | |
43 | -------------- | |
44 | ||
45 | You can authenticate with Twitter in three ways: NoAuth, OAuth, or | |
46 | UserPassAuth. Get help() on these classes to learn how to use them. | |
47 | ||
48 | OAuth is probably the most useful. | |
49 | ||
50 | ||
51 | Working with OAuth | |
52 | ------------------ | |
53 | """ | |
54 | ||
55 | __doc__ += dedent(oauth_doc) | |
56 | ||
57 | __all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError", | |
58 | "TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth", | |
59 | "read_token_file", "write_token_file", "oauth_dance", "OAuth2"] |