Skip to content
Social auth made simple
Python Other

README.rst

Python Social Auth

Python Social Auth is an easy-to-setup social authentication/registration mechanism with support for several frameworks and auth providers.

Crafted using base code from django-social-auth, it implements a common interface to define new authentication providers from third parties, and to bring support for more frameworks and ORMs.

https://travis-ci.org/omab/python-social-auth.png?branch=master https://badge.fury.io/py/python-social-auth.png https://pypip.in/d/python-social-auth/badge.png Documentation Status

Features

This application provides user registration and login using social sites credentials. Here are some features, which is probably not a full list yet.

Supported frameworks

Multiple frameworks are supported:

More frameworks can be added easily (and should be even easier in the future once the code matures).

Auth providers

Several services are supported by simply defining backends (new ones can be easily added or current ones extended):

User data

Basic user data population, to allow custom field values from provider's response.

Social accounts association

Multiple social accounts can be associated to a single user.

Authentication processing

Extensible pipeline to handle authentication/association mechanism in ways that suits your project.

Dependencies

Dependencies that must be met to use the application:

Documents

Project homepage is available at http://psa.matiasaguirre.net/ and documents at http://psa.matiasaguirre.net or http://python-social-auth.readthedocs.org/.

Installation

From pypi:

$ pip install python-social-auth

Or:

$ easy_install python-social-auth

Or clone from github:

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

And add social to PYTHONPATH:

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

Or:

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

Upgrading

Django with South

Upgrading from 0.1 to 0.2 is likely to cause problems trying to apply a migration when the tables already exist. In this case a fake migration needs to be applied:

$ python manage.py migrate --fake default

Support

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

http://www.codersclan.net/graphics/getSupport_github4.png

Copyrights and License

python-social-auth is protected by BSD license. Check the LICENSE for details.

The base work was derived from django-social-auth work and copyrighted too, check django-social-auth LICENSE for details:

Something went wrong with that request. Please try again.