twython/docs/usage/advanced_usage.rst

105 lines
No EOL
2.9 KiB
ReStructuredText

.. _advanced-usage:
Advanced Usage
==============
This section will cover how to use Twython and interact with some a little more advanced API calls
Before you make any API calls, make sure you :ref:`authenticated <starting-out>` the user!
.. note:: All sections on this page will assume you're using a Twython instance
*******************************************************************************
Create a Twython instance with your application keys and the users OAuth tokens::
from twython import Twython
twitter = Twython(APP_KEY, APP_SECRET
OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
Updating Status with Image
--------------------------
Documentation: https://dev.twitter.com/docs/api/1.1/get/account/verify_credentials
::
photo = open('/path/to/file/image.jpg', 'rb')
twitter.update_status_with_media(status='Checkout this cool image!', media=photo)
Search Generator
----------------
So, if you're pretty into Python, you probably know about `generators <http://docs.python.org/2/tutorial/classes.html#generators>`_
That being said, Twython offers a generator for search results and can be accessed by using the following code:
::
search = twitter.search_gen('python')
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!