[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 .stream import TwitterStream
from .oauth_dance import oauth_dance

# Who needs Sphinx? Not me!

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

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


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


__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)

__all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError",
           "TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth",
           "read_token_file", "write_token_file", "oauth_dance"]
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)
dd648a25	15	from .stream import TwitterStream
a6a7f763	16	from .oauth_dance import oauth_dance
24950891 MV	17
	18	# Who needs Sphinx? Not me!
	19
	20	__doc__ += """
	21	The Twitter class
	22	=================
	23	"""
a6a7f763	24	__doc__ += dedent(Twitter.__doc__)
24950891 MV	25
	26	__doc__ += """
	27	The TwitterStream class
	28	=======================
	29	"""
a6a7f763	30	__doc__ += dedent(TwitterStream.__doc__)
24950891 MV	31
	32
	33	__doc__ += """
	34	Twitter Response Objects
	35	========================
	36	"""
a6a7f763	37	__doc__ += dedent(TwitterResponse.__doc__)
24950891 MV	38
	39
	40	__doc__ += """
a6a7f763 MV	41	Authentication
a6a7f763 MV	42	==============
24950891 MV	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
a6a7f763	47	OAuth is probably the most useful.
24950891	48
24950891	49
a6a7f763 MV	50	Working with OAuth
a6a7f763 MV	51	==================
24950891 MV	52	"""
24950891 MV	53
a6a7f763 MV	54	__doc__ += dedent(oauth_doc)
a6a7f763 MV	55
24950891 MV	56	__all__ = ["Twitter", "TwitterStream", "TwitterResponse", "TwitterError",
24950891 MV	57	"TwitterHTTPError", "NoAuth", "OAuth", "UserPassAuth",
a6a7f763	58	"read_token_file", "write_token_file", "oauth_dance"]