]> jfr.im git - z_archive/twitter.git/blobdiff - twitter/cmdline.py
- Documentation updates.
[z_archive/twitter.git] / twitter / cmdline.py
index d466edc2d3d67e4e838508a239f5e1e6db6828cb..21c26c9e7b22b558300f6c7fc049b5b4676b0fe4 100644 (file)
@@ -3,21 +3,22 @@ USAGE:
 
  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
  leave          remove the specified user from your following list
  public         get latest public tweets
  replies        get latest replies
- search         searchtwitter (Beware: octothorpe, escape it)
+ search         search twitter (Beware: octothorpe, escape it)
  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)
@@ -29,6 +30,7 @@ OPTIONS:
  -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
 
@@ -37,16 +39,19 @@ 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'
@@ -67,13 +72,7 @@ from api import Twitter, TwitterError
 from oauth import OAuth
 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,
@@ -89,18 +88,14 @@ OPTIONS = {
 }
 
 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)        
 
     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
@@ -118,6 +113,8 @@ def parse_args(args, options):
             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]
@@ -431,6 +428,10 @@ class HelpAction(Action):
     def __call__(self, twitter, options):
         print __doc__
 
+class DoNothingAction(Action):
+    def __call__(self, twitter, options):
+        pass
+
 def parse_oauth_tokens(result):
     for r in result.split('&'):
         k, v = r.split('=')
@@ -456,6 +457,9 @@ paste or type it here:
     webbrowser.open(
         'http://api.twitter.com/oauth/authorize?oauth_token=' +
         oauth_token)
+    time.sleep(2) # Sometimes the last command can print some
+                  # crap. Wait a bit so it doesn't mess up the next
+                  # prompt.
     oauth_verifier = raw_input("Please type the PIN: ").strip()
     twitter = Twitter(
         auth=OAuth(
@@ -467,11 +471,13 @@ paste or type it here:
     print >> oauth_file, oauth_token
     print >> oauth_file, oauth_token_secret
     oauth_file.close()
+    print
     print "That's it! Your authorization keys have been written to %s." % (
         options['oauth_filename'])
 
 
 actions = {
+    'authorize' : DoNothingAction,
     'follow'    : FollowAction,
     'friends'   : FriendsAction,
     'help'      : HelpAction,
@@ -488,11 +494,15 @@ def loadConfig(filename):
     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
 
+def read_oauth_file(fn):
+    f = open(fn)
+    return f.readline().strip(), f.readline().strip()
+
 def main(args=sys.argv[1:]):
     arg_options = {}
     try:
@@ -517,18 +527,19 @@ def main(args=sys.argv[1:]):
         '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)
-
-    if options['email'] and not options['password']:
-        options['password'] = getpass("Twitter password: ")
+        return 1
 
-    if options['action'] == 'authorize':
+    if (options['action'] == 'authorize'
+        or not os.path.exists(options['oauth_filename'])):
         oauth_dance(options)
-        return 0
 
+    oauth_token, oauth_token_secret = read_oauth_file(options['oauth_filename'])
+    
     twitter = Twitter(
-        email=options['email'], password=options['password'], agent=AGENT_STR,
+        auth=OAuth(
+            oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET),
         secure=options['secure'])
+
     try:
         Action()(twitter, options)
     except NoSuchActionError, e: