isabella232 / django-social-auth Goto Github PK

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.

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.

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 (C) 2007 Simon Willison
  Copyright (C) 2008-2010 Canonical Ltd.