]> jfr.im git - z_archive/twitter.git/blame - README
Stream example and some fixes for py27. Breaks in py3 probably.
[z_archive/twitter.git] / README
CommitLineData
fdbae010 1Python Twitter Tools
a65893e4 2====================
fdbae010 3
f1a8ed67 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.
fdbae010 7
f1a8ed67 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
5b8b1ead 10favorite shell and an IRC bot that can announce Twitter updates to an
f1a8ed67 11IRC channel.
fdbae010 12
5f47b302 13For more information, after installing the `twitter` package:
fdbae010 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
8be9a740 18 * visit http://mike.verdone.ca/twitter for more info
19
a65893e4
MV
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
5f47b302 31 * view tweets from lists
a65893e4
MV
32 * various output formats for tweet information
33 * read your username and password from a config file
34
35The bottom line: type `twitter`, receive tweets.
36
37
38
39The IRC Bot
40===========
41
42The IRC bot is associated with a twitter account (either your own account or an
43account you create for the bot). The bot announces all tweets from friends
44it is following. It can be made to follow or leave friends through IRC /msg
45commands.
46
5f47b302
MV
47
48
49twitter-log
50===========
51
52`twitter-log` is a simple command-line tool that dumps all public
53tweets from a given user in a simple text format. It is useful to get
54a complete offsite backup of all your tweets. Run `twitter-log` and
55read the instructions.
56
57
8be9a740 58Python Twitter Tools are released under an MIT License.