Metadata-Version: 1.1
Name: django-admin-oauth2
Version: 0.1.1
Summary: A django app that replaces the django admin authentication mechanism by deferring to an oauth2 provider
Home-page: https://github.com/RealGeeks/django-admin-oauth2
Author: Real Geeks LLC
Author-email: andrew@realgeeks.com
License: MIT
Description: # django-admin-oauth2
        
        A django app that replaces the django admin authentication mechanism by
        deferring to an oauth2 provider.
        
        [![Build Status](https://travis-ci.org/RealGeeks/django-admin-oauth2.png?branch=master)](https://travis-ci.org/RealGeeks/django-admin-oauth2)
        
        
        ## Installation
        
        Step 1: `pip install django-admin-oauth2` and include it in your project's requirements
        
        Step 2:  Include the django-admin-oauth2 urlconf in your project's urls.py:
        
        ```python
        url(r'/admin/oauth/', include('oauthadmin.urls'))
        ```
        
        Step 3: Include oauthadmin in your INSTALLED_APPS:
        
        ```python
        INSTALLED_APPS = (
            'oauthadmin'
        )
        ````
        
        
        Step 4: Install the middleware in your project's settings.py:
        
        ```python
        MIDDLEWARE_CLASSES = (
            'oauthadmin.middleware.OauthAdminSessionMiddleware'
        )
        ```
        
        *make sure that this comes AFTER 'django.contrib.sessions.middleware.SessionMiddleware'*
        
        Step 5: If you are on Django 1.5 or above, you'll need to set your session serializer
        to "django.contrib.sessions.serializers.PickleSerializer" since we are storing the
        pickled user object in the session.
        
        ```python
        SESSION_SERIALIZER = "django.contrib.sessions.serializers.PickleSerializer"
        
        ```
        
        Step 6: Set up all the correct options (see below for available options)
        
        ## Settings
        
         * OAUTHADMIN_GET_USER: This is function that is given the oauth token and returns
           a django.auth.models.User model corresponding to the currently logged-in user.
           You can set permissions on this user object and stuff.
         * OAUTHADMIN_CLIENT_ID: Your oAuth client ID
         * OAUTHADMIN_CLIENT_SECRET: oAuth client secret
         * OAUTHADMIN_BASE_URL: The landing point for all oAuth related queries.
         * OATHADMIN_AUTH_URL: oAuth provider URL
         * OAUTHADMIN_TOKEN_URL: oAuth bearer token provider URL
        
        ## Testing
        
        If you want to test this app, install the requirements needed for testing:
        
        ```
        pip install -r test-requirements.txt
        ```
        
        and then run the tests with the provided script:
        
        ```
        ./runtests.sh
        ```
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
