A Python library for OAuth 1.0/a, 2.0, and Ofly.
Pull request Compare This branch is 317 commits behind litl:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
examples
rauth
tests
.gitignore
AUTHORS.markdown
LICENSE
MANIFEST.in
README.markdown
setup.py

README.markdown

Rauth: OAuth 1.0/a, 2.0, and Ofly for Python

This package provides OAuth 1.0/a, 2.0, and Ofly consumer support. The package is wrapped around the superb Python Requests.

Installation

Install the package with one of the following commands:

$ easy_install rauth

or

$ pip install rauth

Example Usage

Using the package is quite simple. Ensure that Python Requests is installed. Import the relevant module and start utilizing OAuth endpoints!

Let's get a user's Twitter timeline. Start by creating a service container object:

from rauth.service import OAuth1Service

# Get a real consumer key & secret from https://dev.twitter.com/apps/new
twitter = OAuth1Service(
    name='twitter',
    consumer_key='YOUR_CONSUMER_KEY',
    consumer_secret='YOUR_CONSUMER_SECRET',
    request_token_url='https://api.twitter.com/oauth/request_token',
    access_token_url='https://api.twitter.com/oauth/access_token',
    authorize_url='https://api.twitter.com/oauth/authorize',
    header_auth=True)

Then get an OAuth 1.0 request token:

request_token, request_token_secret = \
    twitter.get_request_token(http_method='GET')

Go through the authentication flow. Since our example is a simple console application, Twitter will give you a PIN to enter.

authorize_url = twitter.get_authorize_url(request_token)

print 'Visit this URL in your browser: ' + authorize_url
pin = raw_input('Enter PIN from browser: ')

Exchange the authorized request token for an access token:

response = twitter.get_access_token(request_token,
                                    request_token_secret,
                                    http_method='GET',
                                    oauth_verifier=pin)
data = response.content

access_token = data['oauth_token']
access_token_secret = data['oauth_token_secret']

And now we can fetch our Twitter timeline!

params = {'include_rts': 1,  # Include retweets
          'count': 10}       # 10 tweets

response = twitter.request(
    'GET',
    'https://api.twitter.com/1/statuses/home_timeline.json',
    access_token,
    access_token_secret,
    header_auth=True,
    params=params)

for i, tweet in enumerate(response.content, 1):
    handle = tweet['user']['screen_name'].encode('utf-8')
    text = tweet['text'].encode('utf-8')
    print '{0}. @{1} - {2}'.format(i, handle, text)

The full example is in examples/twitter-timeline.py.

Documentation

The Sphinx-compiled documentation is available here: http://packages.python.org/rauth/

Copyright and License

Rauth is Copyright (c) 2012 litl, LLC and licensed under the MIT license. See the LICENSE file for full details.