django-socialregistration 0.4.4

Requirements

• Django

• oauth2

• python-openid

• python-sdk

Installation

pip install django-socialregistration
pip install -e git+https://github.com/facebook/python-sdk.git#egg=FacebookSDK

Configuration

1. Add socialregistration to your INSTALLED_APPS

2. Add django.core.context_processors.request to the TEMPLATE_CONTEXT_PROCESSORS

3. Include socialregistration.urls in your top level urls:

   urlpatterns = patterns('',
       # ...
       url(r'^social/', include('socialregistration.urls')))

4. Make sure you are using a RequestContext wherever you are planning to display the login buttons

   from django.template import RequestContext
   
   def login(request):
       # ...
       return render_to_response('login.html',
           {}, context_instance = RequestContext(request))

5. Once you’re done, and configured, etc, don’t forget to python manage.py syncdb your project.

Facebook Connect

{% facebook_button 'http://example.com/other_facebook_button.png' %}

Twitter

{% twitter_button 'http://example.com/other_twitter_button.png' %}

OAuth

Check out how the Twitter authentication works. Basically it’s just plugging together some urls and creating an auth backend, a model and a view.

OpenID

Logging users out

You can use the standard {% url auth_logout %}. Alternatively there is also {% url social_logout %} which is basically a wrapper around auth_logout.

This will log users only out of your site.

To make sure they’re logged out of other sites too, use something like this:

<a href="#" onclick:"javascript:FB.logout(function(resp){ document.location = '{% url social_logout %}'; })">Logout</a>

Or redirect them to the provider they logged in from.

Additional Settings

SOCIALREGISTRATION_USE_HTTP = False
SOCIALREGISTRATION_GENERATE_USERNAME = False

Set either True if you want to enable HTTPS or have the users skip the username form.

Signals

The app provides two signals that fire when users connect their accounts and log in:

socialregistration.signals.connect
socialregistration.signals.login

The signal handlers needs to accept three arguments, and can listen on specific profiles:

from socialregistration import signals
from socialregistration import models

def connect_facebook(user, profile, client, **kwargs):
    # Do fancy stuff like fetching more user info with the client
    pass

def login_facebook(user, profile, client, **kwargs):
    # Do fancy stuff like finding logged in friends
    pass

signals.connect.connect(connect_facebook, sender = models.FacebookProfile)
signals.login.connect(login_facebook, sender = models.FacebookProfile)

This works too with OpenID and OAuth profiles.