Twython is a library providing an easy (and up-to-date) way to access Twitter data in Python. Actively maintained and featuring support for both Python 2.6+ and Python 3, it's been battle tested by companies, educational institutions and individuals alike. Try it today!
.. image:: https://travis-ci.org/ryanmcgrath/twython.png?branch=master + :target: https://travis-ci.org/ryanmcgrath/twython +.. image:: https://pypip.in/d/twython/badge.png + :target: https://crate.io/packages/twython/ +.. image:: https://coveralls.io/repos/ryanmcgrath/twython/badge.png?branch=master + :target: https://coveralls.io/r/ryanmcgrath/twython?branch=master
-Twython is the premier Python library providing an easy (and up-to-date) way to access Twitter data. Actively maintained and featuring support for Python 2.6+ and Python 3. It's been battle tested by companies, educational institutions and individuals alike. Try it today!
the docs <https://dev.twitter.com/docs/api/1.1>_(pip install | easy_install) twython
+Install Twython via pip <http://www.pip-installer.org/>_
+
+.. code-block:: bash
+
+$ pip install twython
-... or, you can clone the repo and install it the old fashioned way
+or, with easy_install <http://pypi.python.org/pypi/setuptools>_
+
+.. code-block:: bash
+
+$ easy_install twython
+
+
+But, hey... that's up to you <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>_.
+
+Or, if you want the code that is currently on GitHub
+
+.. code-block:: bash
git clone git://github.com/ryanmcgrath/twython.git
cd twython
-sudo python setup.py install
+python setup.py install
-Usage
+
+Documentation
-Authorization URL
+Documentation is available at https://twython.readthedocs.org/en/latest/
-from twython import Twython
+
+Starting Out
-t = Twython(app_key, app_secret)
+First, you'll want to head over to https://dev.twitter.com/apps and register an application!
-auth_props = t.get_authentication_tokens(callback_url='http://google.com')
+After you register, grab your applications Consumer Key and Consumer Secret from the application details tab.
-oauth_token = auth_props['oauth_token']
-oauth_token_secret = auth_props['oauth_token_secret']
+The most common type of authentication is Twitter user authentication using OAuth 1. If you're a web app planning to have users sign up with their Twitter account and interact with their timelines, updating their status, and stuff like that this is the authentication for you!
-print 'Connect to Twitter via: %s' % auth_props['auth_url']
-
+First, you'll want to import Twython
-Be sure you have a URL set up to handle the callback after the user has allowed your app to access their data, the callback can be used for storing their final OAuth Token and OAuth Token Secret in a database for use at a later date.
+.. code-block:: python
-Handling the callback
+from twython import Twython
+
-from twython import Twython
+Authentication
-# oauth_token_secret comes from the previous step
-# if needed, store that in a session variable or something.
-# oauth_verifier and oauth_token from the previous call is now REQUIRED # to pass to get_authorized_tokens
+
+Obtain Authorization URL
+^^^^^^^^^^^^^^^^^^^^^^^^
-# In Django, to get the oauth_verifier and oauth_token from the callback
-# url querystring, you might do something like this:
-# oauth_token = request.GET.get('oauth_token')
-# oauth_verifier = request.GET.get('oauth_verifier')
+Now, you'll want to create a Twython instance with your ``Consumer Key`` and ``Consumer Secret``
-t = Twython(app_key, app_secret,
- oauth_token, oauth_token_secret)
+ Only pass *callback_url* to *get_authentication_tokens* if your application is a Web Application
-auth_tokens = t.get_authorized_tokens(oauth_verifier)
-print auth_tokens
-
+ Desktop and Mobile Applications **do not** require a callback_url
-Function definitions (i.e. get_home_timeline()) can be found by reading over twython/endpoints.py
+.. code-block:: python
-Getting a user home timeline
+ APP_KEY = 'YOUR_APP_KEY'
+ APP_SECET = 'YOUR_APP_SECRET'
-from twython import Twython
+ twitter = Twython(APP_KEY, APP_SECRET)
-# oauth_token and oauth_token_secret are the final tokens produced
-# from the 'Handling the callback' step
+ auth = twitter.get_authentication_tokens(callback_url='http://mysite.com/callback')
-t = Twython(app_key, app_secret,
- oauth_token, oauth_token_secret)
+From the ``auth`` variable, save the ``oauth_token`` and ``oauth_token_secret`` for later use (these are not the final auth tokens). In Django or other web frameworks, you might want to store it to a session variable
-# Returns an dict of the user home timeline
-print t.get_home_timeline()
-
+.. code-block:: python
-Catching exceptions
+ OAUTH_TOKEN = auth['oauth_token']
+ OAUTH_TOKEN_SECRET = auth['oauth_token_secret']
-
-Twython offers three Exceptions currently: TwythonError, TwythonAuthError and TwythonRateLimitError
-
+Send the user to the authentication url, you can obtain it by accessing
-from twython import Twython, TwythonAuthError
+.. code-block:: python
-t = Twython(MY_WRONG_APP_KEY, MY_WRONG_APP_SECRET,
- BAD_OAUTH_TOKEN, BAD_OAUTH_TOKEN_SECRET)
+ auth['auth_url']
-try:
- t.verify_credentials()
-except TwythonAuthError as e:
- print e
-
+Handling the Callback
+^^^^^^^^^^^^^^^^^^^^^
-Dynamic function arguments
+ If your application is a Desktop or Mobile Application *oauth_verifier* will be the PIN code
+
+After they authorize your application to access some of their account details, they'll be redirected to the callback url you specified in ``get_autentication_tokens``
+
+You'll want to extract the ``oauth_verifier`` from the url.
+
+Django example:
+
+.. code-block:: python
+
+ oauth_verifier = request.GET['oauth_verifier']
+
+Now that you have the ``oauth_verifier`` stored to a variable, you'll want to create a new instance of Twython and grab the final user tokens
+
+.. code-block:: python
+
+ twitter = Twython(APP_KEY, APP_SECRET,
+ OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
+
+ final_step = twitter.get_authorized_tokens(oauth_verifier)
+
+Once you have the final user tokens, store them in a database for later use!::
+
+ OAUTH_TOKEN = final_step['oauth_token']
+ OAUTH_TOKEN_SECERT = final_step['oauth_token_secret']
+
+For OAuth 2 (Application Only, read-only) authentication, see `our documentation <https://twython.readthedocs.org/en/latest/usage/starting_out.html#oauth-2-application-authentication>`_
+
+Dynamic Function Arguments
++Keyword arguments to functions are mapped to the functions available for each endpoint in the Twitter API docs. Doing this allows us to be incredibly flexible in querying the Twitter API, so changes to the API aren't held up from you using them by this library.
-https://dev.twitter.com/docs/api/1.1/post/statuses/update says it takes "status" amongst other arguments
-
from twython import Twython, TwythonAuthError
+Function definitions (i.e. get_home_timeline()) can be found by reading over twython/endpoints.py
-t = Twython(app_key, app_secret,
- oauth_token, oauth_token_secret)
+Create a Twython instance with your application keys and the users OAuth tokens
-try:
- t.update_status(status='Hey guys!')
-except TwythonError as e:
- print e
-.. code-block:: python
--+https://dev.twitter.com/docs/api/1.1/get/search/tweets says it takes "q" and "result_type" amongst other arguments
-
from twython import Twython
+twitter = Twython(APP_KEY, APP_SECRET
+ OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
+from twython import Twython, TwythonAuthError
+Authenticated Users Home Timeline
-t = Twython(app_key, app_secret,
- oauth_token, oauth_token_secret)
+
+Documentation: https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline
-try:
- t.search(q='Hey guys!')
- t.search(q='Hey guys!', result_type='popular')
-except TwythonError as e:
- print e
-
from twython import TwythonStreamer
+Updating Status
+
-class MyStreamer(TwythonStreamer):
- def on_success(self, data):
- print data
+This method makes use of dynamic arguments, read more about them <https://twython.readthedocs.org/en/latest/usage/starting_out.html#dynamic-function-arguments>_
Documentation: https://dev.twitter.com/docs/api/1/post/statuses/update
-# Requires Authentication as of Twitter API v1.1 -stream = MyStreamer(APP_KEY, APP_SECRET, - OAUTH_TOKEN, OAUTH_TOKEN_SECRET) +.. code-block:: python
-stream.statuses.filter(track='twitter') -twitter.update_status(status='See how easy using Twython is!')
+Searching
-
+ https://dev.twitter.com/docs/api/1.1/get/search/tweets says it takes "q" and "result_type" amongst other arguments
-My hope is that Twython is so simple that you'd never have to ask any questions, but if you feel the need to contact me for this (or other) reasons, you can hit me up at ryan@venodesigns.net.
+.. code-block:: python
-Or if I'm to busy to answer, feel free to ping mikeh@ydekproductions.com as well.
+ twitter.search(q='twitter')
+ twitter.search(q='twitter', result_type='popular')
-Follow us on Twitter:
+Advanced Usage
+--------------
-Want to help?
+- `Advanced Twython Usage <https://twython.readthedocs.org/en/latest/usage/advanced_usage.html>`_
+- `Streaming with Twython <https://twython.readthedocs.org/en/latest/usage/streaming_api.html>`_
-Twython is useful, but ultimately only as useful as the people using it (say that ten times fast!). If you'd like to help, write example code, contribute patches, document things on the wiki, tweet about it. Your help is always appreciated!
+
+Notes
+-----
+
+- Twython 3.0.0 has been injected with 1000mgs of pure awesomeness! OAuth 2 application authentication is now supported. And a *whole lot* more! See the `CHANGELOG <https://github.com/ryanmcgrath/twython/blob/master/HISTORY.rst#300-2013-06-18>`_ for more details!
+
+Questions, Comments, etc?
+-------------------------
+
+My hope is that Twython is so simple that you'd never *have* to ask any questions, but if you feel the need to contact me for this (or other) reasons, you can hit me up at ryan@venodesigns.net.
+
+Or if I'm to busy to answer, feel free to ping mikeh@ydekproductions.com as well.
+
+Follow us on Twitter:
+
+- `@ryanmcgrath <https://twitter.com/ryanmcgrath>`_
+- `@mikehelmick <https://twitter.com/mikehelmick>`_
+
+Want to help?
+-------------
+
+Twython is useful, but ultimately only as useful as the people using it (say that ten times fast!). If you'd like to help, write example code, contribute patches, document things on the wiki, tweet about it. Your help is always appreciated!
+