redarrowdev/python-social-auth

Python Social Auth made easy

Python Social Auth

Python Social Auth is an easy to setup social authentication/registration mechanism with support for several frameworks and auth providers.

Crafted using base code from django-social-auth, implements a common interface to define new authentication providers from third parties. And to bring support for more frameworks and ORMs.

Table of Contents

Features

This application provides user registration and login using social sites credentials, here are some features, probably not a full list yet.

Supported frameworks

Multiple frameworks support:

• Django
• Flask
• Webpy

More frameworks can be added easily (and should be even easier in the future once the code matures).

Auth providers

Several supported service by simple backends definition (easy to add new ones or extend current one):

• Angel OAuth2
• Behance OAuth2
• Bitbucket OAuth1
• Dailymotion OAuth2
• Disqus OAuth2
• Douban OAuth1 and OAuth2
• Dropbox OAuth1
• Evernote OAuth1
• Facebook OAuth2 and OAuth2 for Applications
• Fitbit OAuth1
• Flickr OAuth1
• Foursquare OAuth2
• Google App Engine Auth
• Github OAuth2
• Google OAuth1, OAuth2 and OpenId
• Instagram OAuth2
• Linkedin OAuth1
• Live OAuth2
• Livejournal OpenId
• Mailru OAuth2
• Mixcloud OAuth2
• Mozilla Persona
• Odnoklassniki OAuth2 and Application Auth
• OpenId
• Orkut OAuth1
• Podio OAuth2
• Rdio OAuth1 and OAuth2
• Readability OAuth1
• Shopify OAuth2
• Skyrock OAuth1
• Soundcloud OAuth2
• Stackoverflow OAuth2
• Steam OpenId
• Stocktwits OAuth2
• Stripe OAuth2
• Tripit OAuth1
• Tumblr OAuth1
• Twilio Auth
• Twitter OAuth1
• VK.com OpenAPI, OAuth2 and OAuth2 for Applications
• Weibo OAuth2
• Xing OAuth1
• Yahoo OpenId and OAuth1
• Yammer OAuth2
• Yandex OAuth1, OAuth2 and OpenId

User data

Basic user data population, to allows custom fields values from providers response.

Social accounts association

Multiple social accounts can be associated to a single user.

Authentication processing

Extensible pipeline to handle authentication/association mechanism in ways that suits your project.

Dependencies

Dependencies that must be meet to use the application:

• OpenId support depends on python-openid
• OAuth support depends on python-oauth2 (despite the name, this is just for OAuth1)
• Several backends demands application registration on their corresponding sites and other dependencies like sqlalchemy on Flask and Webpy.

Documents

Project homepage is available at http://psa.matiasaguirre.net/ and documents at http://psa.matiasaguirre.net/docs/.

Installation

From pypi:

$ pip install python-social-auth

Or:

$ easy_install python-social-auth

Or clone from github:

$ git clone git://github.com/omab/python-social-auth.git

And add social to PYTHONPATH:

$ export PYTHONPATH=$PYTHONPATH:$(pwd)/python-social-auth/

Or:

$ cd python-social-auth
$ sudo python setup.py install

Copyrights and Licence

python-social-auth is protected by BSD licence. Check the LICENCE for details.

The base work was derived from django-social-auth work and copyrighted too, check django-social-auth LICENCE for details: