django-simple-social

Introduction

The Django-Simple-Social library downloads a collection of social network libraries and provides automatic backends, and interfaces for working with them. The goal of this project is to simplify working with third-party apps and authorization tools, such as Facebook, LinkedIn, and Twitter.

Make sure you also read up on Djagno-Social-User, as it provides the foundational infrastructure for this library:

https://github.com/mattsnider/Djagno-Social-User

Keep in mind this library is still under development, so there may be breaking changes. I'll update the documentation anytime that happens, but feel free to contact me as well.

All functions and classes are documented inline. If you have additional questions, I can be reached on github or at [e-mail].

Getting started

Standard stuff applies to install. Use PIP to install with dependencies:

pip install django-simple-social

Or install from the command line:

python setup.py install

Dependencies

There many dependencies for this library, because it requires APIs for working with each social network:

django 1.3 or greater
Django-Social-User
LinkedIn-API-JSON-Client
twython

Usage Guide

Add to both dependencies to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'django_simple_social',
    'django_social_user',
    ...
]

Update the DB:

python manage.py sqlall django_social_user > temp.sql
python manage.py manage.py dbshell < temp.sql
rm temp.sql

Register any social network backends you want to use in your settings.py:

AUTHENTICATION_BACKENDS = (
    'django_simple_social.backends.FacebookBackend',
    'django_simple_social.backends.LinkedInBackend',
    'django_simple_social.backends.TwitterBackend',
    ...
    'django.contrib.auth.backends.ModelBackend')

Add any required API keys (backend dependent) to settings.py, here are some examples:

FACEBOOK_CONSUMER_KEY = 'asdf' # this is the APP_ID
FACEBOOK_CONSUMER_SECRET = 'asdf'
LINKED_IN_CONSUMER_KEY = 'asdf'
LINKED_IN_CONSUMER_SECRET = 'asdf'
TWITTER_CONSUMER_KEY = 'asdf'
TWITTER_CONSUMER_SECRET = 'asdf'

Run the backend autodiscover in urls.py:

import django_simple_social; django_simple_social.autodiscover()

Include references to Django-Social-User urls in urls.py:

urlpatterns = patterns('',
    ...
    url(r'^social/', include('django_social_user.urls', namespace='django_social_user')),
    ...
    (r'^admin/', include(admin.site.urls)),)

To begin the oauth process with a social network, expose the following link to an enduser:

<a href="{% url 'django_social_user:authenticate' 'facebook' %}">Sign in with Facebook</a>
<a href="{% url 'django_social_user:authenticate' 'linkedin' %}">Sign in with LinkedIn</a>
<a href="{% url 'django_social_user:authenticate' 'twitter' %}">Sign in with Twitter</a>

Todo

1. Support facebook 2. django_social_user should support South migrations 3. Support google 4. Support openid 5. Better error handling 6. Asynchronous/JS driven authentication, instead of browser redirects 7. Decouple APIs from this infrastructure and allow API customizatio