Skip to main content

A generic system for interacting with remote APIs that need to create Django socials.

Project description

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 admin@mattsnider.com.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-simple-social-0.1.10.tar.gz (7.1 kB view details)

Uploaded Source

Built Distributions

django_simple_social-0.1.10-py27-none-any.whl (8.9 kB view details)

Uploaded Python 2.7

File details

Details for the file django-simple-social-0.1.10.tar.gz.

File metadata

File hashes

Hashes for django-simple-social-0.1.10.tar.gz
Algorithm Hash digest
SHA256 099c888d96233251282219d43d49e9c45fb8b19336f59b3a2adc040b48798e4a
MD5 b002cc85ee04415c601e1803b117f1a6
BLAKE2b-256 2009f4a706ad9db1258817742c0983b0d29bfdd22356ead7ff4af870d447d151

See more details on using hashes here.

File details

Details for the file django_simple_social-0.1.10-py27-none-any.whl.

File metadata

File hashes

Hashes for django_simple_social-0.1.10-py27-none-any.whl
Algorithm Hash digest
SHA256 c7295e986e666b6cf5275e485f6bb1d93898f75c18ed9256321e1801413ec1b5
MD5 e1df5aaa976fd163fe3ef76f258f8861
BLAKE2b-256 ed670008c906bed89a9d482c25a39d485ffc70d1afe759cd3ae36955460a124d

See more details on using hashes here.

File details

Details for the file django-simple-social-0.1.10.macosx-10.8-intel.exe.

File metadata

File hashes

Hashes for django-simple-social-0.1.10.macosx-10.8-intel.exe
Algorithm Hash digest
SHA256 da0432483c809669a52678e758edca88e31bfe7501eace6cb07680751451289c
MD5 a404a76609c7812b39b8b4c07c1291fa
BLAKE2b-256 aaa733763c9edf8a70c0803a7c71e3332d04b3ee641821bfe3735b5e64e3b6b4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page