Note about new Streaming API stuff
This commit is contained in:
parent
9deced8f8b
commit
e0c76501ba
2 changed files with 54 additions and 2 deletions
|
|
@ -16,7 +16,7 @@ for those types of use cases. Twython cannot help you with that or fix the annoy
|
||||||
If you need OAuth, though, Twython now supports it, and ships with a skeleton Django application to get you started.
|
If you need OAuth, though, Twython now supports it, and ships with a skeleton Django application to get you started.
|
||||||
Enjoy!
|
Enjoy!
|
||||||
|
|
||||||
Requirements (2.7 and below; for 3k, read section further down)
|
Requirements (2.6~ and below; for 3k, read section further down)
|
||||||
-----------------------------------------------------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------
|
||||||
Twython (for versions of Python before 2.6) requires a library called
|
Twython (for versions of Python before 2.6) requires a library called
|
||||||
"simplejson". Depending on your flavor of package manager, you can do the following...
|
"simplejson". Depending on your flavor of package manager, you can do the following...
|
||||||
|
|
@ -53,6 +53,32 @@ results = twitter.search(q = "bert")
|
||||||
# very self documenting.
|
# very self documenting.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Streaming API
|
||||||
|
----------------------------------------------------------------------------------------------------
|
||||||
|
Twython, as of v1.5.0, now includes an experimental **[Twitter Streaming API](https://dev.twitter.com/docs/streaming-api)** handler.
|
||||||
|
Usage is as follows; it's designed to be open-ended enough that you can adapt it to higher-level (read: Twitter must give you access)
|
||||||
|
streams. This also exists in large part (read: pretty much in full) thanks to the excellent **[python-requests](http://docs.python-requests.org/en/latest/) library by
|
||||||
|
Kenneth Reitz.
|
||||||
|
|
||||||
|
**Example Usage:**
|
||||||
|
``` python
|
||||||
|
import json
|
||||||
|
from twython import Twython
|
||||||
|
|
||||||
|
def on_results(results):
|
||||||
|
"""
|
||||||
|
A callback to handle passed results. Wheeee.
|
||||||
|
"""
|
||||||
|
print json.dumps(results)
|
||||||
|
|
||||||
|
Twython.stream({
|
||||||
|
'username': 'your_username',
|
||||||
|
'password': 'your_password',
|
||||||
|
'track': 'python'
|
||||||
|
}, on_results)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
A note about the development of Twython (specifically, 1.3)
|
A note about the development of Twython (specifically, 1.3)
|
||||||
----------------------------------------------------------------------------------------------------
|
----------------------------------------------------------------------------------------------------
|
||||||
As of version 1.3, Twython has been extensively overhauled. Most API endpoint definitions are stored
|
As of version 1.3, Twython has been extensively overhauled. Most API endpoint definitions are stored
|
||||||
|
|
|
||||||
28
README.txt
28
README.txt
|
|
@ -16,7 +16,7 @@ for those types of use cases. Twython cannot help you with that or fix the annoy
|
||||||
If you need OAuth, though, Twython now supports it, and ships with a skeleton Django application to get you started.
|
If you need OAuth, though, Twython now supports it, and ships with a skeleton Django application to get you started.
|
||||||
Enjoy!
|
Enjoy!
|
||||||
|
|
||||||
Requirements (2.7 and below; for 3k, read section further down)
|
Requirements (2.6~ and below; for 3k, read section further down)
|
||||||
-----------------------------------------------------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------
|
||||||
Twython (for versions of Python before 2.6) requires a library called
|
Twython (for versions of Python before 2.6) requires a library called
|
||||||
"simplejson". Depending on your flavor of package manager, you can do the following...
|
"simplejson". Depending on your flavor of package manager, you can do the following...
|
||||||
|
|
@ -53,6 +53,32 @@ results = twitter.search(q = "bert")
|
||||||
# very self documenting.
|
# very self documenting.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Streaming API
|
||||||
|
----------------------------------------------------------------------------------------------------
|
||||||
|
Twython, as of v1.5.0, now includes an experimental **[Twitter Streaming API](https://dev.twitter.com/docs/streaming-api)** handler.
|
||||||
|
Usage is as follows; it's designed to be open-ended enough that you can adapt it to higher-level (read: Twitter must give you access)
|
||||||
|
streams. This also exists in large part (read: pretty much in full) thanks to the excellent **[python-requests](http://docs.python-requests.org/en/latest/) library by
|
||||||
|
Kenneth Reitz.
|
||||||
|
|
||||||
|
**Example Usage:**
|
||||||
|
``` python
|
||||||
|
import json
|
||||||
|
from twython import Twython
|
||||||
|
|
||||||
|
def on_results(results):
|
||||||
|
"""
|
||||||
|
A callback to handle passed results. Wheeee.
|
||||||
|
"""
|
||||||
|
print json.dumps(results)
|
||||||
|
|
||||||
|
Twython.stream({
|
||||||
|
'username': 'your_username',
|
||||||
|
'password': 'your_password',
|
||||||
|
'track': 'python'
|
||||||
|
}, on_results)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
A note about the development of Twython (specifically, 1.3)
|
A note about the development of Twython (specifically, 1.3)
|
||||||
----------------------------------------------------------------------------------------------------
|
----------------------------------------------------------------------------------------------------
|
||||||
As of version 1.3, Twython has been extensively overhauled. Most API endpoint definitions are stored
|
As of version 1.3, Twython has been extensively overhauled. Most API endpoint definitions are stored
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue