README

   1 Python Twitter Tools
   2 ====================
   3
   4 The Minimalist Twitter API for Python is a Python API for Twitter,
   5 everyone's favorite Web 2.0 Facebook-style status updater for people
   6 on the go.
   7
   8 Also included is a twitter command-line tool for getting your friends'
   9 tweets and setting your own tweet from the safety and security of your
  10 favorite shell and an IRC bot that can announce Twitter updates to an
  11 IRC channel.
  12
  13 For more information, after installing the `twitter` package:
  14
  15  * import the `twitter` package and run help() on it
  16  * run `twitter -h` for command-line tool help
  17  * run `twitterbot -h` for IRC bot help
  18  * visit http://mike.verdone.ca/twitter for more info
  19
  20
  21
  22 The Command-Line Tool
  23 =====================
  24
  25 The command-line tool currently supports the following things:
  26
  27  * view your friends' recent tweets
  28  * view your recent replies
  29  * view the public timeline
  30  * follow and unfollow (leave) friends
  31  * view tweets from lists
  32  * various output formats for tweet information
  33  * read your username and password from a config file
  34
  35 The bottom line: type `twitter`, receive tweets.
  36
  37
  38
  39 The IRC Bot
  40 ===========
  41
  42 The IRC bot is associated with a twitter account (either your own account or an
  43 account you create for the bot). The bot announces all tweets from friends
  44 it is following. It can be made to follow or leave friends through IRC /msg
  45 commands.
  46
  47
  48
  49 twitter-log
  50 ===========
  51
  52 `twitter-log` is a simple command-line tool that dumps all public
  53 tweets from a given user in a simple text format. It is useful to get
  54 a complete offsite backup of all your tweets. Run `twitter-log` and
  55 read the instructions.
  56
  57
  58 Python Twitter Tools are released under an MIT License.