Add Twitter Streaming API example to Advanced Usage docs
authorJason Emerick <jemerick@gmail.com>
Mon, 19 Dec 2011 16:45:32 +0000 (11:45 -0500)
committerJason Emerick <jemerick@gmail.com>
Mon, 19 Dec 2011 16:45:32 +0000 (11:45 -0500)
docs/user/advanced.rst

index 099dabd76ddde9ac0a572d9f0c2c467a46150daa..4b3430f266e44993d1482c36ed5cb08734611041 100644 (file)
@@ -243,6 +243,27 @@ Then, we can make a request using our Pizza Auth::
     <Response [200]>
 
 
+Streaming Requests
+------------------
+
+With ``requests.Response.iter_lines()`` you can easily iterate over streaming 
+APIs such as the `Twitter Streaming API <https://dev.twitter.com/docs/streaming-api>`_.
+
+To use the Twitter Streaming API to track the keyword "requests":
+
+::
+
+    import requests
+    import json
+
+    r = requests.post('https://stream.twitter.com/1/statuses/filter.json',
+        data={'track': 'requests'}, auth=('username', 'password'))
+
+    for line in r.iter_lines():
+           if line: # filter out keep-alive new lines
+                   print json.loads(line)
+
+
 Verbose Logging
 ---------------