Metadata-Version: 2.1
Name: django-labs-accounts
Version: 0.3.5
Summary: Reusable Django app for Penn Labs accounts
Home-page: https://github.com/pennlabs/django-labs-accounts
Author: Penn Labs
Author-email: admin@pennlabs.org
License: MIT
Download-URL: https://github.com/pennlabs/django-labs-accounts/tarball/master
Description: Django Labs Accounts
        ====================
        .. image:: https://img.shields.io/circleci/project/github/pennlabs/django-labs-accounts/master.svg
            :target: https://circleci.com/gh/pennlabs/django-labs-accounts
        .. image:: https://coveralls.io/repos/github/pennlabs/django-labs-accounts/badge.svg?branch=master
            :target: https://coveralls.io/github/pennlabs/django-labs-accounts?branch=master
        .. image:: https://img.shields.io/pypi/v/django-labs-accounts.svg
            :target: https://pypi.org/project/django-labs-accounts/
        
        Requirements
        ------------
        * Python 3.4+
        * Django 2.0+
        
        Installation
        ------------
        Install with pipenv
            pipenv install django-labs-accounts
        
        Add ``accounts`` to ``INSTALLED_APPS``
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
                'accounts.apps.AccountsConfig',
                ...
            )
        
        Add the new accounts backend to ``AUTHENTICATION_BACKENDS``
        
        .. code-block:: python
        
            AUTHENTICATION_BACKENDS = (
                ...
                'django.contrib.auth.backends.ModelBackend',
                ...
            )
        
        Add the following to ``urls.py``
        
        .. code-block:: python
        
            urlpatterns = [
                ...
                path('accounts/', include('accounts.urls', namespace='accounts')),
                ...
            ]
        
        Documentation
        -------------
        All settings are handled with a ``PLATFORM_ACCOUNTS`` dictionary.
        
        Example:
        
        .. code-block:: python
        
            PLATFORM_ACCOUNTS = {
                'CLIENT_ID': 'id',
                'CLIENT_SECRET': 'secret',
                'REDIRECT_URI': 'example',
                'ADMIN_PERMISSION': 'example_admin'
            }
        
        The available settings are:
        
        ``CLIENT_ID`` the client ID to connect to platform with. Defaults to ``LABS_CLIENT_ID`` environment variable.
        
        ``CLIENT_SECRET`` the client secret to connect to platform with. Defaults to ``LABS_CLIENT_SECRET`` environment variable.
        
        ``REDIRECT_URI`` the redirect uri to send to platform. Defaults to ``LABS_REDIRECT_URI`` environment variable.
        
        ``SCOPE`` the scope for this applications tokens. Must include ``introspection``. Defaults to ``['read', 'introspection']``.
        
        ``PLATFORM_URL`` URL of platform server to connect to. Should be ``https://platform(-dev).pennlabs.org`` (no trailing slash)
        
        ``ADMIN_PERMISSION`` The name of the permission on platform to grant admin access. Defaults to ``example_admin``
        
        |
        
        When developing with an http (not https) callback URL, it may be helpful to set the ``OAUTHLIB_INSECURE_TRANSPORT`` environment variable.
        
        .. code-block:: python
        
            os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = "1"
        
        Changelog
        ---------
        See `CHANGELOG.md <https://github.com/pennlabs/django-labs-accounts/blob/master/CHANGELOG.md>`_.
        
        License
        -------
        See `LICENSE.md <https://github.com/pennlabs/django-labs-accounts/blob/master/LICENSE.md>`_.
        
Keywords: django,accounts,penn labs
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/x-rst
