+# encoding: utf-8
"""
USAGE:
twitter [action] [options]
+
ACTIONS:
- follow add the specified user to your follow list
+ authorize authorize the command-line tool to interact with Twitter
+ follow follow a user
friends get latest tweets from your friends (default action)
help print this help text that you are currently reading
- leave remove the specified user from your following list
+ leave stop following a user
+ list get list of a user's lists; give a list name to get
+ tweets from that list
+ mylist get list of your lists; give a list name to get tweets
+ from that list
public get latest public tweets
- replies get latest replies
- search searchtwitter (Beware: octothorpe, escape it)
+ replies get latest replies to you
+ search search twitter (Beware: octothorpe, escape it)
set set your twitter status
- shell login the twitter shell
+ shell login to the twitter shell
+
OPTIONS:
- -e --email <email> your email to login to twitter
- -p --password <password> your twitter password
-r --refresh run this command forever, polling every once
in a while (default: every 5 minutes)
-R --refresh-rate <rate> set the refresh rate (in seconds)
-l --length <count> specify number of status updates shown
(default: 20, max: 200)
-t --timestamp show time before status lines
- -d --datestamp shoe date before status lines
- --no-ssl use HTTP instead of more secure HTTPS
+ -d --datestamp show date before status lines
+ --no-ssl use less-secure HTTP instead of HTTPS
+ --oauth <filename> filename to read/store oauth credentials to
FORMATS for the --format option
urls nothing but URLs
ansi ansi colour (rainbow mode)
+
CONFIG FILES
- The config file should contain a [twitter] header, and all the desired options
- you wish to set, like so:
+ The config file should be placed in your home directory and be named .twitter.
+ It must contain a [twitter] header, and all the desired options you wish to
+ set, like so:
[twitter]
-email: <username>
-password: <password>
format: <desired_default_format_for_output>
prompt: <twitter_shell_prompt e.g. '[cyan]twitter[R]> '>
+
+ OAuth authentication tokens are stored in the file .twitter_oauth in your
+ home directory.
"""
CONSUMER_KEY='uS6hO2sV6tDKIOeVjhnFnQ'
import webbrowser
from api import Twitter, TwitterError
-from oauth import OAuth
+from oauth import OAuth, write_token_file, read_token_file
+from oauth_dance import oauth_dance
import ansi
-
-# Please don't change this, it was provided by the fine folks at Twitter.
-# If you change it, it will not work.
-AGENT_STR = "twittercommandlinetoolpy"
+from util import smrt_input
OPTIONS = {
- 'email': None,
- 'password': None,
'action': 'friends',
'refresh': False,
'refresh_rate': 600,
}
def parse_args(args, options):
- long_opts = ['email', 'password', 'help', 'format', 'refresh',
- 'refresh-rate', 'config', 'length', 'timestamp',
+ long_opts = ['help', 'format=', 'refresh', 'oauth=',
+ 'refresh-rate=', 'config=', 'length=', 'timestamp',
'datestamp', 'no-ssl']
short_opts = "e:p:f:h?rR:c:l:td"
- opts, extra_args = getopt(args, short_opts, long_opts)
+ opts, extra_args = getopt(args, short_opts, long_opts)
for opt, arg in opts:
- if opt in ('-e', '--email'):
- options['email'] = arg
- elif opt in ('-p', '--password'):
- options['password'] = arg
- elif opt in ('-f', '--format'):
+ if opt in ('-f', '--format'):
options['format'] = arg
elif opt in ('-r', '--refresh'):
options['refresh'] = True
options['config_filename'] = arg
elif opt == '--no-ssl':
options['secure'] = False
+ elif opt == '--oauth':
+ options['oauth_filename'] = arg
if extra_args and not ('action' in options and options['action'] == 'help'):
options['action'] = extra_args[0]
return time.strftime("%H:%M:%S ", t)
elif datestamp:
return time.strftime("%Y-%m-%d ", t)
- return ""
+ return ""
class StatusFormatter(object):
def __call__(self, status, options):
urls = self.urlmatch.findall(status['text'])
return u'\n'.join(urls) if urls else ""
+
+class ListsFormatter(object):
+ def __call__(self, list):
+ if list['description']:
+ list_str = u"%-30s (%s)" % (list['name'], list['description'])
+ else:
+ list_str = u"%-30s" % (list['name'])
+ return u"%s\n" % list_str
+
+class ListsVerboseFormatter(object):
+ def __call__(self, list):
+ list_str = u"%-30s\n description: %s\n members: %s\n mode:%s\n" % (list['name'], list['description'], list['member_count'], list['mode'])
+ return list_str
+
+class AnsiListsFormatter(object):
+ def __init__(self):
+ self._colourMap = ansi.ColourMap()
+
+ def __call__(self, list):
+ colour = self._colourMap.colourFor(list['name'])
+ return (u"%s%-15s%s %s" %(
+ ansi.cmdColour(colour), list['name'],
+ ansi.cmdReset(), list['description']))
+
+
class AdminFormatter(object):
def __call__(self, action, user):
user_str = u"%s (%s)" %(user['screen_name'], user['name'])
ansi.cmdColour(colour), result['from_user'],
ansi.cmdReset(), result['text']))
+_term_encoding = None
+def get_term_encoding():
+ global _term_encoding
+ if not _term_encoding:
+ lang = os.getenv('LANG', 'unknown.UTF-8').split('.')
+ if lang[1:]:
+ _term_encoding = lang[1]
+ else:
+ _term_encoding = 'UTF-8'
+ return _term_encoding
+
formatters = {}
status_formatters = {
'default': StatusFormatter,
}
formatters['search'] = search_formatters
+lists_formatters = {
+ 'default': ListsFormatter,
+ 'verbose': ListsVerboseFormatter,
+ 'urls': None,
+ 'ansi': AnsiListsFormatter
+}
+formatters['lists'] = lists_formatters
+
def get_formatter(action_type, options):
formatters_dict = formatters.get(action_type)
if (not formatters_dict):
def __call__(self, twitter, options):
raise NoSuchActionError("No such action: %s" %(options['action']))
-def printNicely(string):
+def printNicely(string):
if sys.stdout.encoding:
print string.encode(sys.stdout.encoding, 'replace')
else:
# We need to be pointing at search.twitter.com to work, and it is less
# tangly to do it here than in the main()
twitter.domain="search.twitter.com"
+ twitter.uriparts=()
# We need to bypass the TwitterCall parameter encoding, so we
# don't encode the plus sign, so we have to encode it ourselves
- query_string = "+".join([quote(term) for term in options['extra_args']])
- twitter.encoded_args = "q=%s" %(query_string)
+ query_string = "+".join(
+ [quote(term.decode(get_term_encoding()))
+ for term in options['extra_args']])
- results = twitter.search()['results']
+ results = twitter.search(q=query_string)['results']
f = get_formatter('search', options)
for result in results:
resultStr = f(result, options)
else:
printNicely(af(options['action'], user))
+class ListsAction(StatusAction):
+ def getStatuses(self, twitter, options):
+ if not options['extra_args']:
+ raise TwitterError("Please provide a user to query for lists")
+
+ screen_name = options['extra_args'][0]
+
+ if not options['extra_args'][1:]:
+ lists = twitter.user.lists(user=screen_name)['lists']
+ if not lists:
+ printNicely("This user has no lists.")
+ for list in lists:
+ lf = get_formatter('lists', options)
+ printNicely(lf(list))
+ return []
+ else:
+ return reversed(twitter.user.lists.list.statuses(
+ user=screen_name, list=options['extra_args'][1]))
+
+
+class MyListsAction(ListsAction):
+ def getStatuses(self, twitter, options):
+ screen_name = twitter.account.verify_credentials()['screen_name']
+ options['extra_args'].insert(0, screen_name)
+ return ListsAction.getStatuses(self, twitter, options)
+
+
class FriendsAction(StatusAction):
def getStatuses(self, twitter, options):
return reversed(twitter.statuses.friends_timeline(count=options["length"]))
class SetStatusAction(Action):
def __call__(self, twitter, options):
- statusTxt = (u" ".join(options['extra_args'])
+ statusTxt = (" ".join(options['extra_args']).decode(get_term_encoding())
if options['extra_args']
else unicode(raw_input("message: ")))
status = (statusTxt.encode('utf8', 'replace'))
else:
raise SystemExit(0)
+class PythonPromptAction(Action):
+ def __call__(self, twitter, options):
+ try:
+ while True:
+ smrt_input(globals(), locals())
+ except EOFError:
+ pass
+
class HelpAction(Action):
def __call__(self, twitter, options):
print __doc__
-def parse_oauth_tokens(result):
- for r in result.split('&'):
- k, v = r.split('=')
- if k == 'oauth_token':
- oauth_token = v
- elif k == 'oauth_token_secret':
- oauth_token_secret = v
- return oauth_token, oauth_token_secret
-
-def oauth_dance(options):
- print ("Hi there! We're gonna get you all set up to use Twitter"
- " on the command-line.")
- twitter = Twitter(
- auth=OAuth('', '', CONSUMER_KEY, CONSUMER_SECRET),
- format='')
- oauth_token, oauth_token_secret = parse_oauth_tokens(
- twitter.oauth.request_token())
- print """
-In the web browser window that opens please choose to Allow access to the
-command-line tool. Copy the PIN number that appears on the next page and
-paste or type it here:
-"""
- webbrowser.open(
- 'http://api.twitter.com/oauth/authorize?oauth_token=' +
- oauth_token)
- oauth_verifier = raw_input("Please type the PIN: ").strip()
- twitter = Twitter(
- auth=OAuth(
- oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET),
- format='')
- oauth_token, oauth_token_secret = parse_oauth_tokens(
- twitter.oauth.access_token(oauth_verifier=oauth_verifier))
- oauth_file = open(options['oauth_filename'], 'w')
- print >> oauth_file, oauth_token
- print >> oauth_file, oauth_token_secret
- oauth_file.close()
- print "That's it! Your authorization keys have been written to %s." % (
- options['oauth_filename'])
-
+class DoNothingAction(Action):
+ def __call__(self, twitter, options):
+ pass
actions = {
+ 'authorize' : DoNothingAction,
'follow' : FollowAction,
'friends' : FriendsAction,
+ 'list' : ListsAction,
+ 'mylist' : MyListsAction,
'help' : HelpAction,
'leave' : LeaveAction,
'public' : PublicAction,
+ 'pyprompt' : PythonPromptAction,
'replies' : RepliesAction,
'search' : SearchAction,
'set' : SetStatusAction,
if os.path.exists(filename):
cp = SafeConfigParser()
cp.read([filename])
- for option in ('email', 'password', 'format', 'prompt'):
+ for option in ('format', 'prompt'):
if cp.has_option('twitter', option):
options[option] = cp.get('twitter', option)
return options
print >> sys.stderr
raise SystemExit(1)
- config_options = loadConfig(
+ config_path = os.path.expanduser(
arg_options.get('config_filename') or OPTIONS.get('config_filename'))
+ config_options = loadConfig(config_path)
# Apply the various options in order, the most important applied last.
# Defaults first, then what's read from config file, then command-line
'friends', 'public', 'replies'):
print >> sys.stderr, "You can only refresh the friends, public, or replies actions."
print >> sys.stderr, "Use 'twitter -h' for help."
- raise SystemExit(1)
+ return 1
+
+ oauth_filename = os.path.expanduser(options['oauth_filename'])
- if options['email'] and not options['password']:
- options['password'] = getpass("Twitter password: ")
+ if (options['action'] == 'authorize'
+ or not os.path.exists(oauth_filename)):
+ oauth_dance(
+ "the Command-Line Tool", CONSUMER_KEY, CONSUMER_SECRET,
+ options['oauth_filename'])
- if options['action'] == 'authorize':
- oauth_dance(options)
- return 0
+ oauth_token, oauth_token_secret = read_token_file(oauth_filename)
twitter = Twitter(
- email=options['email'], password=options['password'], agent=AGENT_STR,
- secure=options['secure'])
+ auth=OAuth(
+ oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET),
+ secure=options['secure'],
+ api_version='1',
+ domain='api.twitter.com')
+
try:
Action()(twitter, options)
except NoSuchActionError, e:
print >>sys.stderr, e
raise SystemExit(1)
except TwitterError, e:
- print >> sys.stderr, e.args[0]
+ print >> sys.stderr, str(e)
print >> sys.stderr, "Use 'twitter -h' for help."
raise SystemExit(1)
projects / z_archive / twitter.git / blobdiff