twitter [action] [options]
+
ACTIONS:
+ authorize authorize the command-line tool to interact with Twitter
follow add the specified user to your follow list
friends get latest tweets from your friends (default action)
help print this help text that you are currently reading
set set your twitter status
shell login 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)
(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
+ --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 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)
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, format="%a %b %d %H:%M:%S +0000 %Y"):
timestamp = options["timestamp"]
datestamp = options["datestamp"]
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" %(
result['from_user'], result['text']))
class VerboseSearchFormatter(SearchFormatter):
- pass #Default to the regular one
-
+ pass #Default to the regular one
+
class URLSearchFormatter(object):
urlmatch = re.compile(r'https?://\S+')
def __call__(self, result, options):
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" %(
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,
def get_formatter(action_type, options):
formatters_dict = formatters.get(action_type)
if (not formatters_dict):
- raise TwitterError(
+ raise TwitterError(
"There was an error finding a class of formatters for your type (%s)"
%(action_type))
f = formatters_dict.get(options['format'])
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:
default = False
return default
-
+
def __call__(self, twitter, options):
action = actions.get(options['action'], NoSuchAction)()
try:
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)
# 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"
- results = twitter.search(q=options['extra_args'])['results']
+ twitter.uri=""
+ # 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']])
+ twitter.encoded_args = "q=%s" %(query_string)
+
+ results = twitter.search()['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'] and options['extra_args'][0]):
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'))
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:
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,
'help' : HelpAction,
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
'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
+
+ if (options['action'] == 'authorize'
+ or not os.path.exists(options['oauth_filename'])):
+ oauth_dance(
+ "the Command-Line Tool", CONSUMER_KEY, CONSUMER_SECRET,
+ options['oauth_filename'])
- if options['email'] and not options['password']:
- options['password'] = getpass("Twitter password: ")
+ oauth_token, oauth_token_secret = read_token_file(options['oauth_filename'])
+
+ 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)
projects / z_archive / twitter.git / blobdiff