added timeout option to TwitterStream

[z_archive/twitter.git] / README

diff --git a/README b/README
index 225e5cb770a2577e015e6e0e78a52bc07f286390..8e3a5346109e5e4953df8eda4cb385f6d889abc5 100644 (file)
--- a/README
+++ b/README
@@ -96,6 +96,12 @@ t.statuses.friends_timeline(id="billybob")
 # Also supported (but totally weird)
 t.statuses.friends_timeline.billybob()
 
 # Also supported (but totally weird)
 t.statuses.friends_timeline.billybob()
 

+# to pass in GET/POST parameters, such as `count`
+t.statuses.home_timeline(count=5)
+
+# to pass in the GET/POST parameter `id` you need to use `_id`
+t.statuses.oembed(_id=1234567890)
+

 # Update your status
 t.statuses.update(
     status="Using @sixohsix's sweet Python Twitter Tools.")
 # Update your status
 t.statuses.update(
     status="Using @sixohsix's sweet Python Twitter Tools.")


@@ -116,8 +122,13 @@ t.user.list.members(user="tamtar", list="things-that-are-rad")
 # calls which take much more time than normal or twitter stops
 # responding for some reasone
 t.users.lookup(screen_name=','.join(A_LIST_OF_100_SCREEN_NAMES), _timeout=1)
 # calls which take much more time than normal or twitter stops
 # responding for some reasone
 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::
 
 
 Searching Twitter::
 


@@ -180,6 +191,38 @@ 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.
 
 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 retreive 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
 ------------------------
 
 Twitter Response Objects
 ------------------------