django social auth

Django social authentication made simple

omab
2652
756
Python

NOTE: THIS LIBRARY IS DEPRECATED IN FAVOR OF python-social-auth. RIGHT NOW
THIS LIBRARY DEPENDS DIRECTLY ON python-social-auth AND SHOULD BE CONSIDERED
AS A MIGRATION STEP

Django Social Auth

Django Social Auth is an easy way to setup social authentication/authorization
mechanism for Django projects.

Crafted using base code from django-twitter-oauth_ and django-openid-auth_,
it implements a common interface to define new authentication providers from
third parties.

You can view this app’s documentation on Read the Docs_ too.

… contents:: Table of Contents

Features

This application provides user registration and login using social site
credentials. Some features are:

  • Registration and login with social sites using the following providers
    at the moment:

    • Google OpenID_
    • Google OAuth_
    • Google OAuth2_
    • Yahoo OpenID_
    • OpenId_ like myOpenID_
    • Twitter OAuth_
    • Facebook OAuth_

    Some contributions added support for:

    • DISQUS OAuth_
    • LiveJournal OpenID_
    • Orkut OAuth_
    • Linkedin OAuth_
    • Foursquare OAuth2_
    • GitHub OAuth_
    • Dropbox OAuth_
    • Flickr OAuth_
    • Vkontakte OAuth_
    • MSN Live Connect OAuth2_
    • Skyrock OAuth_
    • Yahoo OAuth_
    • Evernote OAuth_
    • Mail.ru OAuth_
    • Odnoklassniki OAuth_
    • Mixcloud OAuth2_
    • BitBucket OAuth_
    • Douban OAuth_
    • Fitbit OAuth_
    • Instagram OAuth2_
    • Twilio_
    • Trello OAuth_
    • Weibo OAuth2_
    • Yandex OpenId_
    • Shopify OAuth2_
    • StockTwits OAuth2_
    • Stackoverflow OAuth2_
    • Fedora OpenID_
    • Exacttarget HubExchange_
    • Appsfuel OAuth2_

  • Basic user data population and signaling to allows custom fields values
    from providers’ responses

  • Multiple social account associations to a single user

  • Custom User model override if needed (auth.User_ by default)

  • Extensible pipeline to handle authentication/association mechanism

Demo

There’s a demo at http://social.matiasaguirre.net/.
Note: It lacks some backends’ support at the moment.

Contact

Join the django-social-auth discussion list_ and bring any questions or suggestions
that would improve this application.

Also join the IRC channel #django-social-auth on Freenode server.

Documentation

Extensive documentation at Read the Docs_.

Dependencies

Dependencies that must be met to use the application:

  • OpenId_ support depends on python-openid_

  • OAuth_ support depends on python-oauth2_

  • Several backends demands application registration on their corresponding
    sites

Installation

From pypi_::

$ pip install django-social-auth

or::

$ easy_install django-social-auth

or clone from github_::

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

and add social_auth to PYTHONPATH::

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

or::

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

Support

If you’re having problems with using the project, use the support forum at CodersClan.

… image:: http://www.codersclan.net/graphics/getSupport_github4.png
:width: 100px
:height: 100px
:scale: 10
:target: http://codersclan.net/forum/index.php?repo_id=7

Copyrights and Licence

django-social-auth is protected by BSD licence.

Some bits were derived from others’ work and copyrighted by:

  • django-twitter-oauth::

    Original Copyright goes to Henrik Lied (henriklied)
    Code borrowed from https://github.com/henriklied/django-twitter-oauth

  • django-openid-auth::

    django-openid-auth - OpenID integration for django.contrib.auth
    Copyright © 2007 Simon Willison
    Copyright © 2008-2010 Canonical Ltd.

… _django-twitter-oauth: https://github.com/henriklied/django-twitter-oauth
… _django-openid-auth: https://launchpad.net/django-openid-auth
… _Read the Docs: http://django-social-auth.readthedocs.org/
… _Google OpenID: https://developers.google.com/accounts/docs/OpenID
… _Google OAuth: https://developers.google.com/accounts/docs/OAuth
… _Google OAuth2: https://developers.google.com/accounts/docs/OAuth2
… _Yahoo OpenID: http://openid.yahoo.com/
… _OpenId: http://openid.net/
… _myOpenID: https://www.myopenid.com/
… _Twitter OAuth: http://dev.twitter.com/pages/oauth_faq
… _Facebook OAuth: http://developers.facebook.com/docs/authentication/
… _DISQUS OAuth: http://disqus.com/api/docs/auth/
… _LiveJournal OpenID: http://www.livejournal.com/support/faqbrowse.bml?faqid=283
… _Orkut OAuth: http://code.google.com/apis/orkut/docs/rest/developers_guide_protocol.html#Authenticating
… _Linkedin OAuth: https://www.linkedin.com/secure/developer
… _Foursquare OAuth2: https://developer.foursquare.com/docs/oauth.html
… _GitHub OAuth: http://developer.github.com/v3/oauth/
… _Dropbox OAuth: https://www.dropbox.com/developers_beta/reference/api
… _Flickr OAuth: http://www.flickr.com/services/api/
… Vkontakte OAuth: http://vk.com/developers.php?oid=-1&p=Авторизация%D1%81%D0%B0%D0%B9%D1%82%D0%BE%D0%B2
… _MSN Live Connect OAuth2: http://msdn.microsoft.com/en-us/library/live/hh243647.aspx
… _Skyrock OAuth: http://www.skyrock.com/developer/
… _Yahoo OAuth: http://developer.yahoo.com/oauth/guide/oauth-auth-flow.html
… _Evernote OAuth: http://dev.evernote.com/documentation/cloud/chapters/Authentication.php
… _Mail.ru OAuth: http://api.mail.ru/docs/guides/oauth/
… _Odnoklassniki OAuth: http://dev.odnoklassniki.ru/wiki/display/ok/The+OAuth+2.0+Protocol
… _Mixcloud OAuth2: http://www.mixcloud.com/developers/documentation/#authorization
… _BitBucket OAuth: https://confluence.atlassian.com/display/BITBUCKET/OAuth+on+Bitbucket
… _Douban OAuth: http://www.douban.com/service/apidoc/auth
… _Fitbit OAuth: https://wiki.fitbit.com/display/API/OAuth+Authentication+in+the+Fitbit+API
… _Instagram OAuth2: http://instagram.com/developer/authentication/
… _Twilio: https://www.twilio.com/user/account/connect/apps
… _Trello OAuth: https://trello.com/docs/gettingstarted/index.html#getting-an-application-key
… _Weibo OAuth2: http://open.weibo.com/wiki/Oauth2
… _Yandex OpenId: http://openid.yandex.ru/
… _Shopify OAuth2: http://api.shopify.com/authentication.html
… _StockTwits OAuth2: http://stocktwits.com/developers/docs/authentication
… _auth.User: http://code.djangoproject.com/browser/django/trunk/django/contrib/auth/models.py#L186
… _python-openid: http://pypi.python.org/pypi/python-openid/
… _python-oauth2: https://github.com/simplegeo/python-oauth2
… _OAuth: http://oauth.net/
… _pypi: http://pypi.python.org/pypi/django-social-auth/
… _github: https://github.com/omab/django-social-auth
… _django-social-auth discussion list: https://groups.google.com/forum/?fromgroups#!forum/django-social-auth
… _Stackoverflow OAuth2: http://api.stackexchange.com/
… _Fedora OpenID: https://fedoraproject.org/wiki/OpenID
… _Exacttarget HubExchange: http://code.exacttarget.com/
… _Appsfuel OAuth2: http://docs.appsfuel.com/api_reference#api_reference
… _python-social-auth: https://github.com/omab/python-social-auth