]> jfr.im git - z_archive/twitter.git/blame_incremental - README
Cleanup help text
[z_archive/twitter.git] / README
... / ...
CommitLineData
1Python Twitter Tools
2====================
3
4The Minimalist Twitter API for Python is a Python API for Twitter,
5everyone's favorite Web 2.0 Facebook-style status updater for people
6on the go.
7
8Also included is a twitter command-line tool for getting your friends'
9tweets and setting your own tweet from the safety and security of your
10favorite shell and an IRC bot that can announce Twitter updates to an
11IRC channel.
12
13For more information, after installing the `twitter` egg:
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
22The Command-Line Tool
23=====================
24
25The 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 * various output formats for tweet information
32 * read your username and password from a config file
33
34The bottom line: type `twitter`, receive tweets.
35
36
37
38The IRC Bot
39===========
40
41The IRC bot is associated with a twitter account (either your own account or an
42account you create for the bot). The bot announces all tweets from friends
43it is following. It can be made to follow or leave friends through IRC /msg
44commands.
45
46Python Twitter Tools are released under an MIT License.