Yahoo! Social SDK - Python

Find documentation and support on Yahoo! Developer Network: http://developer.yahoo.com

• Yahoo! Application Platform - http://developer.yahoo.com/yap/
• Yahoo! Social APIs - http://developer.yahoo.com/social/
• Yahoo! Query Language - http://developer.yahoo.com/yql/

Hosted on GitHub: http://github.com/yahoo/yos-social-python/tree/master

License

@copyright: Copyrights for code authored by Yahoo! Inc. is licensed under the following terms: @license: BSD Open Source License

Yahoo! Social SDK Software License Agreement (BSD License) Copyright (c) 2009, Yahoo! Inc. All rights reserved.

Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The Yahoo! Social Python SDK code is subject to the BSD license, see the LICENSE file.

Requirements

The following dependencies are bundled with the Yahoo! Python SDK, but are under terms of a separate license. See the bundled LICENSE files for more information:

• SimpleJSON - http://code.google.com/p/simplejson
• OAuth - http://code.google.com/p/oauth
• OpenID - http://openidenabled.com/python-openid

Install

To install the library simply make sure that this package is in your PYTHON PATH. The sdk also requires the oauth and simplejson modules:

easy_install oauth simplejson
python setup.py install

Examples

Fetching YQL:

import yahoo.yql

response = yahoo.yql.YQLQuery().execute('select * from delicious.feeds.popular')
if 'query' in response and 'results' in response['query']:
  print response['query']['results']
elif 'error' in response:
  print 'YQL query failed with error: "%s".' % response['error']['description']
else:
  print 'YQL response malformed.'

Fetching Social Data:

import yahoo.application

# Yahoo! OAuth Credentials - http://developer.yahoo.com/dashboard/

CONSUMER_KEY      = '##'
CONSUMER_SECRET   = '##'
APPLICATION_ID    = '##'
CALLBACK_URL      = '##'

oauthapp      = yahoo.application.OAuthApplication(CONSUMER_KEY, CONSUMER_SECRET, APPLICATION_ID, CALLBACK_URL)

# Fetch request token
request_token = oauthapp.get_request_token(CALLBACK_URL)

# Redirect user to authorization url
redirect_url  = oauthapp.get_authorization_url(request_token)

# Exchange request token for authorized access token
verifier  = self.request.get('oauth_verifier') # must fetch oauth_verifier from request

access_token  = oauthapp.get_access_token(request_token, verifier)

# update access token
oauthapp.token = access_token

profile = oauthapp.getProfile()

print profile

Signing with SimpleAuth (OpenID + OAuth):

See the bundled sample code in examples/simpleauth/simpleauth.py.

Fetching people and activities with OpenSocial:

See the bundled sample code in examples/opensocial/profile.py.

Tests

The Yahoo! Python SDK comes with a test suite to validate functionality. The tests also show functional examples and results. To run the test suite, simply execute the test suite:

python test/run_unit_tests.py