]>
Commit | Line | Data |
---|---|---|
fdbae010 | 1 | Python Twitter Tools |
a65893e4 | 2 | ==================== |
fdbae010 | 3 | |
f1a8ed67 | 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. | |
fdbae010 | 7 | |
f1a8ed67 | 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 | |
5b8b1ead | 10 | favorite shell and an IRC bot that can announce Twitter updates to an |
f1a8ed67 | 11 | IRC channel. |
fdbae010 | 12 | |
5f47b302 | 13 | For 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 | |
a65893e4 | 17 | |
51e0b8f1 MV |
18 | |
19 | twitter - The Command-Line Tool | |
20 | ------------------------------- | |
a65893e4 | 21 | |
30913a4e | 22 | The command-line tool lets you do some awesome things: |
a65893e4 | 23 | |
30913a4e | 24 | * view your tweets, recent replies, and tweets in lists |
a65893e4 MV |
25 | * view the public timeline |
26 | * follow and unfollow (leave) friends | |
27 | * various output formats for tweet information | |
51e0b8f1 | 28 | |
a65893e4 MV |
29 | The bottom line: type `twitter`, receive tweets. |
30 | ||
31 | ||
32 | ||
51e0b8f1 MV |
33 | twitterbot - The IRC Bot |
34 | ------------------------ | |
a65893e4 MV |
35 | |
36 | The IRC bot is associated with a twitter account (either your own account or an | |
37 | account you create for the bot). The bot announces all tweets from friends | |
38 | it is following. It can be made to follow or leave friends through IRC /msg | |
39 | commands. | |
40 | ||
5f47b302 | 41 | |
5f47b302 | 42 | twitter-log |
51e0b8f1 | 43 | ----------- |
5f47b302 MV |
44 | |
45 | `twitter-log` is a simple command-line tool that dumps all public | |
46 | tweets from a given user in a simple text format. It is useful to get | |
47 | a complete offsite backup of all your tweets. Run `twitter-log` and | |
48 | read the instructions. | |
49 | ||
30913a4e MV |
50 | twitter-archiver and twitter-follow |
51 | ----------------------------------- | |
52 | ||
53 | twitter-archiver will log all the tweets posted by any user since they | |
54 | started posting. twitter-follow will print a list of all of all the | |
55 | followers of a user (or all the users that user follows). | |
56 | ||
5f47b302 | 57 | |
51e0b8f1 MV |
58 | Programming with the Twitter api classes |
59 | ======================================== | |
60 | ||
61 | ||
62 | The Twitter and TwitterStream classes are the key to building your own | |
63 | Twitter-enabled applications. | |
64 | ||
65 | ||
66 | The Twitter class | |
67 | ----------------- | |
68 | ||
69 | The minimalist yet fully featured Twitter API class. | |
70 | ||
71 | Get RESTful data by accessing members of this class. The result | |
72 | is decoded python objects (lists and dicts). | |
73 | ||
74 | The Twitter API is documented at: | |
75 | ||
76 | http://dev.twitter.com/doc | |
77 | ||
78 | ||
79 | Examples:: | |
4d1e1c4d DC |
80 | |
81 | from twitter import * | |
51e0b8f1 | 82 | |
4d1e1c4d | 83 | # see "Authentication" section below for tokens and keys |
d09c0dd3 | 84 | t = Twitter( |
0cde0254 SM |
85 | auth=OAuth(OAUTH_TOKEN, OAUTH_SECRET, |
86 | CONSUMER_KEY, CONSUMER_SECRET) | |
87 | ) | |
51e0b8f1 MV |
88 | |
89 | # Get the public timeline | |
d09c0dd3 | 90 | t.statuses.public_timeline() |
51e0b8f1 MV |
91 | |
92 | # Get a particular friend's timeline | |
d09c0dd3 | 93 | t.statuses.friends_timeline(id="billybob") |
51e0b8f1 MV |
94 | |
95 | # Also supported (but totally weird) | |
d09c0dd3 MV |
96 | t.statuses.friends_timeline.billybob() |
97 | ||
98 | # Update your status | |
99 | t.statuses.update( | |
100 | status="Using @sixohsix's sweet Python Twitter Tools.") | |
51e0b8f1 MV |
101 | |
102 | # Send a direct message | |
d09c0dd3 | 103 | t.direct_messages.new( |
51e0b8f1 MV |
104 | user="billybob", |
105 | text="I think yer swell!") | |
106 | ||
d09c0dd3 MV |
107 | # Get the members of tamtar's list "Things That Are Rad" |
108 | t._("tamtar")._("things-that-are-rad").members() | |
109 | ||
110 | # Note how the magic `_` method can be used to insert data | |
111 | # into the middle of a call. You can also use replacement: | |
112 | t.user.list.members(user="tamtar", list="things-that-are-rad") | |
51e0b8f1 MV |
113 | |
114 | ||
115 | Searching Twitter:: | |
116 | ||
4d1e1c4d DC |
117 | from twitter import * |
118 | ||
51e0b8f1 MV |
119 | twitter_search = Twitter(domain="search.twitter.com") |
120 | ||
121 | # Find the latest search trends | |
122 | twitter_search.trends() | |
123 | ||
124 | # Search for the latest News on #gaza | |
125 | twitter_search.search(q="#gaza") | |
126 | ||
127 | ||
128 | Using the data returned | |
129 | ----------------------- | |
130 | ||
131 | Twitter API calls return decoded JSON. This is converted into | |
132 | a bunch of Python lists, dicts, ints, and strings. For example:: | |
133 | ||
134 | x = twitter.statuses.public_timeline() | |
135 | ||
136 | # The first 'tweet' in the timeline | |
137 | x[0] | |
138 | ||
139 | # The screen name of the user who wrote the first 'tweet' | |
140 | x[0]['user']['screen_name'] | |
141 | ||
142 | ||
143 | Getting raw XML data | |
144 | -------------------- | |
145 | ||
146 | If you prefer to get your Twitter data in XML format, pass | |
147 | format="xml" to the Twitter object when you instantiate it:: | |
148 | ||
149 | twitter = Twitter(format="xml") | |
150 | ||
151 | The output will not be parsed in any way. It will be a raw string | |
152 | of XML. | |
153 | ||
154 | ||
155 | The TwitterStream class | |
156 | ----------------------- | |
157 | ||
158 | The TwitterStream object is an interface to the Twitter Stream API | |
159 | (stream.twitter.com). This can be used pretty much the same as the | |
160 | Twitter class except the result of calling a method will be an | |
161 | iterator that yields objects decoded from the stream. For | |
162 | example:: | |
163 | ||
164 | twitter_stream = TwitterStream(auth=UserPassAuth('joe', 'joespassword')) | |
165 | iterator = twitter_stream.statuses.sample() | |
166 | ||
167 | for tweet in iterator: | |
168 | ...do something with this tweet... | |
169 | ||
170 | The iterator will yield tweets forever and ever (until the stream | |
171 | breaks at which point it raises a TwitterHTTPError.) | |
172 | ||
173 | The `block` parameter controls if the stream is blocking. Default | |
174 | is blocking (True). When set to False, the iterator will | |
175 | occasionally yield None when there is no available message. | |
176 | ||
177 | Twitter Response Objects | |
178 | ------------------------ | |
179 | ||
180 | Response from a twitter request. Behaves like a list or a string | |
181 | (depending on requested format) but it has a few other interesting | |
182 | attributes. | |
183 | ||
184 | `headers` gives you access to the response headers as an | |
185 | httplib.HTTPHeaders instance. You can do | |
186 | `response.headers.getheader('h')` to retrieve a header. | |
187 | ||
188 | Authentication | |
189 | -------------- | |
190 | ||
191 | You can authenticate with Twitter in three ways: NoAuth, OAuth, or | |
192 | UserPassAuth. Get help() on these classes to learn how to use them. | |
193 | ||
194 | OAuth is probably the most useful. | |
195 | ||
196 | ||
197 | Working with OAuth | |
198 | ------------------ | |
199 | ||
200 | Visit the Twitter developer page and create a new application: | |
201 | ||
202 | https://dev.twitter.com/apps/new | |
203 | ||
204 | This will get you a CONSUMER_KEY and CONSUMER_SECRET. | |
205 | ||
206 | When users run your application they have to authenticate your app | |
207 | with their Twitter account. A few HTTP calls to twitter are required | |
208 | to do this. Please see the twitter.oauth_dance module to see how this | |
209 | is done. If you are making a command-line app, you can use the | |
210 | oauth_dance() function directly. | |
211 | ||
212 | Performing the "oauth dance" gets you an ouath token and oauth secret | |
213 | that authenticate the user with Twitter. You should save these for | |
214 | later so that the user doesn't have to do the oauth dance again. | |
215 | ||
216 | read_token_file and write_token_file are utility methods to read and | |
217 | write OAuth token and secret key values. The values are stored as | |
218 | strings in the file. Not terribly exciting. | |
219 | ||
220 | Finally, you can use the OAuth authenticator to connect to Twitter. In | |
221 | code it all goes like this:: | |
222 | ||
4d1e1c4d DC |
223 | from twitter import * |
224 | ||
51e0b8f1 MV |
225 | MY_TWITTER_CREDS = os.path.expanduser('~/.my_app_credentials') |
226 | if not os.path.exists(MY_TWITTER_CREDS): | |
227 | oauth_dance("My App Name", CONSUMER_KEY, CONSUMER_SECRET, | |
228 | MY_TWITTER_CREDS) | |
229 | ||
230 | oauth_token, oauth_secret = read_token_file(MY_TWITTER_CREDS) | |
231 | ||
232 | twitter = Twitter(auth=OAuth( | |
4d1e1c4d | 233 | oauth_token, oauth_secret, CONSUMER_KEY, CONSUMER_SECRET)) |
51e0b8f1 MV |
234 | |
235 | # Now work with Twitter | |
236 | twitter.statuses.update('Hello, world!') | |
237 | ||
238 | ||
239 | ||
240 | License | |
241 | ======= | |
242 | ||
8be9a740 | 243 | Python Twitter Tools are released under an MIT License. |