Metadata-Version: 1.1
Name: django-sessionprofile
Version: 0.1.1
Summary: Use Django for SSO - this package provides a bridge for third party packages.
Home-page: https://github.com/modelbrouwers/django-sessionprofile
Author: Maykin Media, Sergei Maertens
Author-email: sergeimaertens@gmail.com
License: MIT
Description: Django Sessionprofile
        =====================
        
        .. image:: https://travis-ci.org/modelbrouwers/django-sessionprofile.svg?branch=master
            :target: https://travis-ci.org/modelbrouwers/django-sessionprofile
        
        
        .. image:: https://coveralls.io/repos/modelbrouwers/django-sessionprofile/badge.svg
          :target: https://coveralls.io/r/modelbrouwers/django-sessionprofile
        
        
        django-sessionprofile is the bridge between any software with customizable
        auth backends and Django. If you want to use Django for Single-Sign-On, this
        package does the Django heavy lifting.
        
        
        Installation - Django
        ---------------------
        
            $ pip install django-sessionprofile
        
        Add `sessionprofile` to INSTALLED_APPS, and run `python manage.py migrate`.
        
        Add the sessionprofile middleware (`sessionprofile.middleware.SessionProfileMiddleware`) to your middleware settings - make sure it comes before the `SessionMiddleware`.
        
        Additionally, the session cookie must be available for the third party application,
        this should not be a problem if it lives on the same domain.
        
        Backend
        -------
        Currently one backend is available: `'sessionprofile.backends.DatabaseBackend'`.
        In the future, alternative backends will be possible, like `'sessionprofile.backends.CachedDatabaseBackend'`.
        
        Installation - third party application
        --------------------------------------
        This depends on which backend you decided to use, the example assumes the db
        backend.
        
        When authenticating in the third party application, you should read the session
        cookie (SESSION_COOKIE_NAME), and query the sessionprofile table:
        
            SELECT users_user.username, users_user.email FROM
            users_user, sessionprofile_sessionprofile sp WHERE
            sp.session_id = '<sessionid_from_cookie>'
            AND users_user.id = sp.user_id
        
        It's up to you to implement the rest of the authentication flow. An example for phpBB 3.0.x is provided in the examples folder.
        
        Thanks
        ------
        Many thanks go to Resolver Systems Ltd (now part of PythonAnywhere) who
        made the initial version of this library, specifically aimed on phpBB3.
        
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django :: 1.6
Classifier: Framework :: Django :: 1.7
Classifier: Framework :: Django :: 1.8
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
