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