[z_archive/twitter.git] / twitter / __init__.py

"""
The minimalist yet fully featured Twitter API and Python toolset.

The Twitter and TwitterStream classes are the key to building your own
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,
                    __doc__ as oauth_doc)
from .oauth2 import OAuth2
from .stream import TwitterStream
from .oauth_dance import oauth_dance

__doc__ = __doc__ or ""

__doc__ += """
The Twitter class
-----------------
"""
__doc__ += dedent(Twitter.__doc__ or "")

__doc__ += """
The TwitterStream class
-----------------------
"""
__doc__ += dedent(TwitterStream.__doc__ or "")


__doc__ += """
Twitter Response Objects
------------------------
"""
__doc__ += dedent(TwitterResponse.__doc__ or "")


__doc__ += """
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.


Working with OAuth
------------------
"""

__doc__ += dedent(oauth_doc or "")

__all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError",
           "TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth",
           "read_token_file", "write_token_file", "oauth_dance", "OAuth2"]
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
24950891 MV	5	Twitter-enabled applications.
5f47b302	6
7364ea65	7	"""
7364ea65	8
a6a7f763 MV	9	from textwrap import dedent
a6a7f763 MV	10
f7e63802	11	from .api import Twitter, TwitterError, TwitterHTTPError, TwitterResponse
24950891	12	from .auth import NoAuth, UserPassAuth
a6a7f763 MV	13	from .oauth import (OAuth, read_token_file, write_token_file,
a6a7f763 MV	14	__doc__ as oauth_doc)
e99a58f8	15	from .oauth2 import OAuth2
dd648a25	16	from .stream import TwitterStream
a6a7f763	17	from .oauth_dance import oauth_dance
24950891	18
ede8b119	19	__doc__ = __doc__ or ""
24950891 MV	20
	21	__doc__ += """
	22	The Twitter class
51e0b8f1	23	-----------------
24950891	24	"""
ede8b119	25	__doc__ += dedent(Twitter.__doc__ or "")
24950891 MV	26
	27	__doc__ += """
	28	The TwitterStream class
51e0b8f1	29	-----------------------
24950891	30	"""
ede8b119	31	__doc__ += dedent(TwitterStream.__doc__ or "")
24950891 MV	32
	33
	34	__doc__ += """
	35	Twitter Response Objects
51e0b8f1	36	------------------------
24950891	37	"""
ede8b119	38	__doc__ += dedent(TwitterResponse.__doc__ or "")
24950891 MV	39
	40
	41	__doc__ += """
a6a7f763	42	Authentication
51e0b8f1	43	--------------
24950891 MV	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
a6a7f763	48	OAuth is probably the most useful.
24950891	49
24950891	50
a6a7f763	51	Working with OAuth
51e0b8f1	52	------------------
24950891 MV	53	"""
24950891 MV	54
ede8b119	55	__doc__ += dedent(oauth_doc or "")
a6a7f763	56
24950891 MV	57	__all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError",
24950891 MV	58	"TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth",
e99a58f8	59	"read_token_file", "write_token_file", "oauth_dance", "OAuth2"]