Make tests more robust when run in parallel, to avoid the occasional https://travis...

[z_archive/twitter.git] / README

diff --git a/README b/README
index 225e5cb770a2577e015e6e0e78a52bc07f286390..eefdf2bccccc7cd092c8641adfeeedba310c026e 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,8 @@
 Python Twitter Tools
 ====================
 
+[![Build Status](https://travis-ci.org/sixohsix/twitter.svg)](https://travis-ci.org/sixohsix/twitter)
+
 The Minimalist Twitter API for Python is a Python API for Twitter,
 everyone's favorite Web 2.0 Facebook-style status updater for people
 on the go.
@@ -78,7 +80,7 @@ The Twitter API is documented at:
 
 Examples::
 
-```python 
+```python
 from twitter import *
 
 # see "Authentication" section below for tokens and keys
@@ -91,10 +93,13 @@ t = Twitter(
 t.statuses.home_timeline()
 
 # Get a particular friend's timeline
-t.statuses.friends_timeline(id="billybob")
+t.statuses.user_timeline(screen_name="billybob")
+
+# to pass in GET/POST parameters, such as `count`
+t.statuses.home_timeline(count=5)
 
-# Also supported (but totally weird)
-t.statuses.friends_timeline.billybob()
+# to pass in the GET/POST parameter `id` you need to use `_id`
+t.statuses.oembed(_id=1234567890)
 
 # Update your status
 t.statuses.update(
@@ -113,11 +118,16 @@ t._("tamtar")._("things-that-are-rad").members()
 t.user.list.members(user="tamtar", list="things-that-are-rad")
 
 # An *optional* `_timeout` parameter can also be used for API
-# calls which take much more time than normal or twitter stops
-# responding for some reasone
+# calls which take much more time than normal or Twitter stops
+# responding for some reason
 t.users.lookup(screen_name=','.join(A_LIST_OF_100_SCREEN_NAMES), _timeout=1)
-```
 
+# Overriding Method: GET/POST
+# you should not need to use this method as this library properly
+# detects whether GET or POST should be used, Nevertheless
+# to force a particular method, use `_method`
+t.statuses.oembed(_id=1234567890, _method='GET')
+```
 
 Searching Twitter::
 
@@ -180,10 +190,42 @@ The `block` parameter controls if the stream is blocking. Default
 is blocking (True). When set to False, the iterator will
 occasionally yield None when there is no available message.
 
+Per default the ``TwitterStream`` object uses
+[public streams](https://dev.twitter.com/docs/streaming-apis/streams/public).
+If you want to use one of the other
+[streaming APIs](https://dev.twitter.com/docs/streaming-apis), specify the URL
+manually:
+
+- [Public streams](https://dev.twitter.com/docs/streaming-apis/streams/public): stream.twitter.com
+- [User streams](https://dev.twitter.com/docs/streaming-apis/streams/user): userstream.twitter.com
+- [Site streams](https://dev.twitter.com/docs/streaming-apis/streams/site): sitestream.twitter.com
+
+Note that you require the proper
+[permissions](https://dev.twitter.com/docs/application-permission-model) to
+access these streams. E.g. for direct messages your
+[application](https://dev.twitter.com/apps) needs the "Read, Write & Direct
+Messages" permission.
+
+The following example demonstrates how to retrieve all new direct messages
+from the user stream:
+
+```python
+auth = OAuth(
+    consumer_key='[your consumer key]',
+    consumer_secret='[your consumer secret]',
+    token='[your token]',
+    token_secret='[your token secret]'
+)
+twitter_userstream = TwitterStream(auth=auth, domain='userstream.twitter.com')
+for msg in twitter_userstream.user():
+    if 'direct_message' in msg:
+        print msg['direct_message']['text']
+```
+
 Twitter Response Objects
 ------------------------
 
-Response from a twitter request. Behaves like a list or a string
+Response from a Twitter request. Behaves like a list or a string
 (depending on requested format) but it has a few other interesting
 attributes.
 
@@ -210,12 +252,12 @@ Visit the Twitter developer page and create a new application:
 This will get you a CONSUMER_KEY and CONSUMER_SECRET.
 
 When users run your application they have to authenticate your app
-with their Twitter account. A few HTTP calls to twitter are required
+with their Twitter account. A few HTTP calls to Twitter are required
 to do this. Please see the twitter.oauth_dance module to see how this
 is done. If you are making a command-line app, you can use the
 oauth_dance() function directly.
 
-Performing the "oauth dance" gets you an ouath token and oauth secret
+Performing the "oauth dance" gets you an oauth token and oauth secret
 that authenticate the user with Twitter. You should save these for
 later so that the user doesn't have to do the oauth dance again.
 
@@ -240,7 +282,7 @@ twitter = Twitter(auth=OAuth(
     oauth_token, oauth_secret, CONSUMER_KEY, CONSUMER_SECRET))
 
 # Now work with Twitter
-twitter.statuses.update('Hello, world!')
+twitter.statuses.update(status='Hello, world!')
 ```