code/twython
1
Fork 0
Code Issues 23 Pull requests 4 Projects Releases 5 Packages Wiki Activity Actions

Update docs to give examples for manipulating requests args

Browse source
This commit is contained in:
Mike Helmick 2013-06-10 17:42:26 -04:00
parent a0aae4687d
commit 25cfd0909c
1 changed files with 61 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

61
docs/usage/advanced_usage.rst
View file

@ -40,5 +40,66 @@ That being said, Twython offers a generator for search results and can be access
for result in search:
print result
Manipulate the Request (headers, proxies, etc.)
-----------------------------------------------
There are times when you may want to turn SSL verification off, send custom headers, or add proxies for the request to go through.
Twython uses the `requests <http://python-requests.org>`_ library to make API calls to Twitter. ``requests`` accepts a few parameters to allow developers to manipulate the acutal HTTP request.
Here is an example of sending custom headers to a Twitter API request:
::
from twython import Twython
client_args = {
'headers': {
'User-Agent': 'My App Name'
}
}
twitter = Twython(APP_KEY, APP_SECRET
OAUTH_TOKEN, OAUTH_TOKEN_SECRET
client_args=client_args)
Here is an example of sending the request through proxies:
::
from twython import Twython
client_args = {
'proxies': {
'http': '10.0.10.1:8000',
'https': '10.0.10.1:8001',
}
}
twitter = Twython(APP_KEY, APP_SECRET
OAUTH_TOKEN, OAUTH_TOKEN_SECRET
client_args=client_args)
or both (and set a timeout variable):
::
from twython import Twython
client_args = {
'headers': {
'User-Agent': 'My App Name'
},
'proxies': {
'http': '10.0.10.1:8000',
'https': '10.0.10.1:8001',
}
'timeout': 300,
}
twitter = Twython(APP_KEY, APP_SECRET
OAUTH_TOKEN, OAUTH_TOKEN_SECRET
client_args=client_args)
So now you can authenticate, update your status (with or without an image), search Twitter, and a few other things! Good luck!