Reusable Django app for Penn Labs accounts
Project description
Django Labs Accounts
Requirements
- Python 3.5+
- Django 2.0+
Installation
Install with pip pip install django-labs-accounts
Add accounts
to INSTALLED_APPS
INSTALLED_APPS = (
...
'accounts.apps.AccountsConfig',
...
)
Add the new accounts backend to AUTHENTICATION_BACKENDS
AUTHENTICATION_BACKENDS = (
...
'accounts.backends.LabsUserBackend',
'django.contrib.auth.backends.ModelBackend',
...
)
Add the following to urls.py
urlpatterns = [
...
path('accounts/', include('accounts.urls', namespace='accounts')),
...
]
Documentation
All settings are handled within a PLATFORM_ACCOUNTS
dictionary.
Example:
PLATFORM_ACCOUNTS = {
'CLIENT_ID': 'id',
'CLIENT_SECRET': 'secret',
'REDIRECT_URI': 'example',
'ADMIN_PERMISSION': 'example_admin'
'CUSTOM_ADMIN': True
}
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
CUSTOM_ADMIN
enable the custom admin login page to log in users through platform. Defaults to True
When developing locally with an http (not https) callback URL, it may be helpful to set the OAUTHLIB_INSECURE_TRANSPORT
environment variable.
os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = "1"
Changelog
See CHANGELOG.md
License
See LICENSE.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-labs-accounts-0.3.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8524355d68363b0926b18504dbf43728e97f44783b7238ccffe02dfcfa4f8937 |
|
MD5 | 313790ee64408fb0f8d39f593ca0cc0d |
|
BLAKE2b-256 | 7d9b0f727c609c4ccf0e049300a75e33b962e7138b630600c6ed7edb1485d9c8 |
Hashes for django_labs_accounts-0.3.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | deb62f7bdd9ad2c79ff99b1cbfddc3d3381f9842ab34023d7b0db04e30b11946 |
|
MD5 | 4a575bd59f246cbc9adae1c1028129ee |
|
BLAKE2b-256 | c445ac6ad15102023abbd589d6213d62b4551a45624b7d911124fc132dbd5c48 |