+# 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
+ 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
+ -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'
+CONSUMER_SECRET='MEYTOS97VvlHX7K1rwHPEqVpTSqZ71HtvoK4sVuYk'
+
import sys
import time
from getopt import gnu_getopt as getopt, GetoptError
import re
import os.path
from ConfigParser import SafeConfigParser
+import datetime
+from urllib import quote
+import webbrowser
from api import Twitter, TwitterError
+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"
-
OPTIONS = {
- 'email': None,
- 'password': None,
'action': 'friends',
'refresh': False,
'refresh_rate': 600,
'format': 'default',
'prompt': '[cyan]twitter[R]> ',
'config_filename': os.environ.get('HOME', '') + os.sep + '.twitter',
+ 'oauth_filename': os.environ.get('HOME', '') + os.sep + '.twitter_oauth',
'length': 20,
'timestamp': False,
'datestamp': False,
- 'extra_args': []
+ 'extra_args': [],
+ 'secure': True,
}
def parse_args(args, options):
- long_opts = ['email', 'password', 'help', 'format', 'refresh',
- 'refresh-rate', 'config', 'length', 'timestamp', 'datestamp']
+ 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['action'] = 'help'
elif opt in ('-c', '--config'):
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]
options['extra_args'] = extra_args[1:]
-
-def get_time_string(status, options):
+
+def get_time_string(status, options, format="%a %b %d %H:%M:%S +0000 %Y"):
timestamp = options["timestamp"]
datestamp = options["datestamp"]
- t = time.strptime(status['created_at'], "%a %b %d %H:%M:%S +0000 %Y")
+ t = time.strptime(status['created_at'], format)
+ i_hate_timezones = time.timezone
+ if (time.daylight):
+ i_hate_timezones = time.altzone
+ dt = datetime.datetime(*t[:-3]) - datetime.timedelta(
+ seconds=i_hate_timezones)
+ t = dt.timetuple()
if timestamp and datestamp:
return time.strftime("%Y-%m-%d %H:%M:%S ", t)
elif timestamp:
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):
- return (u"%S%s %s" %(
+ def __call__(self, status, options):
+ return (u"%s%s %s" %(
get_time_string(status, options),
status['user']['screen_name'], status['text']))
class AnsiStatusFormatter(object):
def __init__(self):
self._colourMap = ansi.ColourMap()
-
+
def __call__(self, status, options):
colour = self._colourMap.colourFor(status['user']['screen_name'])
return (u"%s%s%s%s %s" %(
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'])
user['name'],
user['url']))
+class SearchFormatter(object):
+ def __call__(self, result, options):
+ return(u"%s%s %s" %(
+ get_time_string(result, options, "%a, %d %b %Y %H:%M:%S +0000"),
+ result['from_user'], result['text']))
+
+class VerboseSearchFormatter(SearchFormatter):
+ pass #Default to the regular one
+
+class URLSearchFormatter(object):
+ urlmatch = re.compile(r'https?://\S+')
+ def __call__(self, result, options):
+ urls = self.urlmatch.findall(result['text'])
+ return u'\n'.join(urls) if urls else ""
+
+class AnsiSearchFormatter(object):
+ def __init__(self):
+ self._colourMap = ansi.ColourMap()
+
+ def __call__(self, result, options):
+ colour = self._colourMap.colourFor(result['from_user'])
+ return (u"%s%s%s%s %s" %(
+ get_time_string(result, options, "%a, %d %b %Y %H:%M:%S +0000"),
+ 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,
'verbose': VerboseStatusFormatter,
'urls': URLStatusFormatter,
'ansi': AnsiStatusFormatter
}
+formatters['status'] = status_formatters
admin_formatters = {
'default': AdminFormatter,
'urls': AdminFormatter,
'ansi': AdminFormatter
}
+formatters['admin'] = admin_formatters
-def get_status_formatter(options):
- sf = status_formatters.get(options['format'])
- if (not sf):
- raise TwitterError(
- "Unknown formatter '%s'" %(options['format']))
- return sf()
+search_formatters = {
+ 'default': SearchFormatter,
+ 'verbose': VerboseSearchFormatter,
+ 'urls': URLSearchFormatter,
+ 'ansi': AnsiSearchFormatter
+}
+formatters['search'] = search_formatters
+
+lists_formatters = {
+ 'default': ListsFormatter,
+ 'verbose': ListsVerboseFormatter,
+ 'urls': None,
+ 'ansi': AnsiListsFormatter
+}
+formatters['lists'] = lists_formatters
-def get_admin_formatter(options):
- sf = admin_formatters.get(options['format'])
- if (not sf):
+def get_formatter(action_type, options):
+ formatters_dict = formatters.get(action_type)
+ if (not formatters_dict):
raise TwitterError(
- "Unknown formatter '%s'" %(options['format']))
- return sf()
+ "There was an error finding a class of formatters for your type (%s)"
+ %(action_type))
+ f = formatters_dict.get(options['format'])
+ if (not f):
+ raise TwitterError(
+ "Unknown formatter '%s' for status actions" %(options['format']))
+ return f()
class Action(object):
- @staticmethod
- def ask(subject='perform this action', careful=False):
+
+ def ask(self, subject='perform this action', careful=False):
'''
Requests fromt he user using `raw_input` if `subject` should be
performed. When `careful`, the default answer is NO, otherwise YES.
Returns the user answer in the form `True` or `False`.
'''
- sample = '(y/N)' if careful else '(Y/n)'
+ sample = '(y/N)'
+ if not careful:
+ sample = '(Y/n)'
+
prompt = 'You really want to %s %s? ' %(subject, sample)
try:
answer = raw_input(prompt).lower()
if careful:
- if answer not in ('yes', 'y'):
- return False
- else:
- return True
+ return answer in ('yes', 'y')
else:
- if answer in ('no', 'n'):
- return False
- else:
- return True
+ return answer not in ('no', 'n')
except EOFError:
print >>sys.stderr # Put Newline since Enter was never pressed
# TODO:
# Figure out why on OS X the raw_input keeps raising
# EOFError and is never able to reset and get more input
# Hint: Look at how IPython implements their console
- default = False if careful else True
+ default = True
+ if careful:
+ default = False
return default
+
def __call__(self, twitter, options):
action = actions.get(options['action'], NoSuchAction)()
try:
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:
print string.encode('utf-8')
-
+
class StatusAction(Action):
def __call__(self, twitter, options):
statuses = self.getStatuses(twitter, options)
- sf = get_status_formatter(options)
+ sf = get_formatter('status', options)
for status in statuses:
statusStr = sf(status, options)
if statusStr.strip():
printNicely(statusStr)
+class SearchAction(Action):
+ def __call__(self, twitter, options):
+ # 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.decode(get_term_encoding()))
+ for term in options['extra_args']])
+
+ results = twitter.search(q=query_string)['results']
+ f = get_formatter('search', options)
+ for result in results:
+ resultStr = f(result, options)
+ if resultStr.strip():
+ printNicely(resultStr)
+
class AdminAction(Action):
def __call__(self, twitter, options):
- if not options['extra_args'][0]:
+ if not (options['extra_args'] and options['extra_args'][0]):
raise TwitterError("You need to specify a user (screen name)")
- af = get_admin_formatter(options)
+ af = get_formatter('admin', options)
try:
user = self.getUser(twitter, options['extra_args'][0])
except TwitterError, e:
print "There was a problem following or leaving the specified user."
- print " You may be trying to follow a user you are already following;"
- print " Leaving a user you are not currently following;"
- print " Or the user may not exist."
- print " Sorry."
+ print "You may be trying to follow a user you are already following;"
+ print "Leaving a user you are not currently following;"
+ print "Or the user may not exist."
+ print "Sorry."
print
print e
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'))
twitter.statuses.update(status=status)
class TwitterShell(Action):
- @staticmethod
- def render_prompt(prompt):
+
+ def render_prompt(self, prompt):
'''Parses the `prompt` string and returns the rendered version'''
prompt = prompt.strip("'").replace("\\'","'")
for colour in ansi.COLOURS_NAMED:
if '[%s]' %(colour) in prompt:
prompt = prompt.replace(
- '[%s]' %(colour), ansi.cmdColourNamed(colour))
+ '[%s]' %(colour), ansi.cmdColourNamed(colour))
prompt = prompt.replace('[R]', ansi.cmdReset())
return prompt
+
def __call__(self, twitter, options):
prompt = self.render_prompt(options.get('prompt', 'twitter> '))
while True:
+ options['action'] = ""
try:
args = raw_input(prompt).split()
parse_args(args, options)
continue
elif options['action'] == 'help':
print >>sys.stderr, '''\ntwitter> `action`\n
- The Shell Accepts all the command line actions along with:
+ The Shell Accepts all the command line actions along with:
- exit Leave the twitter shell (^D may also be used)
+ exit Leave the twitter shell (^D may also be used)
- Full CMD Line help is appended below for your convinience.'''
+ Full CMD Line help is appended below for your convinience.'''
Action()(twitter, options)
options['action'] = ''
except NoSuchActionError, e:
def __call__(self, twitter, options):
print __doc__
+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,
'replies' : RepliesAction,
+ 'search' : SearchAction,
'set' : SetStatusAction,
'shell' : TwitterShell,
}
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['action'] == 'authorize'
+ or not os.path.exists(oauth_filename)):
+ oauth_dance(
+ "the Command-Line Tool", CONSUMER_KEY, CONSUMER_SECRET,
+ options['oauth_filename'])
+
+ oauth_token, oauth_token_secret = read_token_file(oauth_filename)
- if options['email'] and not options['password']:
- options['password'] = getpass("Twitter password: ")
+ twitter = Twitter(
+ auth=OAuth(
+ oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET),
+ secure=options['secure'],
+ api_version='1',
+ domain='api.twitter.com')
- twitter = Twitter(options['email'], options['password'], agent=AGENT_STR)
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)