Skip to content

Latest commit

 

History

History
282 lines (225 loc) · 8.49 KB

README.rst

File metadata and controls

282 lines (225 loc) · 8.49 KB

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

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

Multiple frameworks are supported:

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

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

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

Multiple social accounts can be associated to a single user.

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

Dependencies that must be met to use the application:

  • OpenId support depends on python-openid
  • OAuth support depends on python-oauth2 (despite the name, this is just for OAuth1)
  • Several backends demand application registration on their corresponding sites and other dependencies like sqlalchemy on Flask and Webpy.
  • Other dependencies:

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

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

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

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

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: