]>
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 .stream import TwitterStream | |
16 | from .oauth_dance import oauth_dance | |
17 | ||
18 | # Who needs Sphinx? Not me! | |
19 | ||
20 | __doc__ += """ | |
21 | The Twitter class | |
22 | ----------------- | |
23 | """ | |
24 | __doc__ += dedent(Twitter.__doc__) | |
25 | ||
26 | __doc__ += """ | |
27 | The TwitterStream class | |
28 | ----------------------- | |
29 | """ | |
30 | __doc__ += dedent(TwitterStream.__doc__) | |
31 | ||
32 | ||
33 | __doc__ += """ | |
34 | Twitter Response Objects | |
35 | ------------------------ | |
36 | """ | |
37 | __doc__ += dedent(TwitterResponse.__doc__) | |
38 | ||
39 | ||
40 | __doc__ += """ | |
41 | Authentication | |
42 | -------------- | |
43 | ||
44 | You can authenticate with Twitter in three ways: NoAuth, OAuth, or | |
45 | UserPassAuth. Get help() on these classes to learn how to use them. | |
46 | ||
47 | OAuth is probably the most useful. | |
48 | ||
49 | ||
50 | Working with OAuth | |
51 | ------------------ | |
52 | """ | |
53 | ||
54 | __doc__ += dedent(oauth_doc) | |
55 | ||
56 | __all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError", | |
57 | "TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth", | |
58 | "read_token_file", "write_token_file", "oauth_dance"] |