Reusable Django app for Penn Labs accounts
Project description
Requirements
Python 3.4+
Django 2.0+
Installation
- Install with pipenv
pipenv install django-labs-accounts
Add accounts to INSTALLED_APPS
INSTALLED_APPS = (
...
'accounts.apps.AccountsConfig',
...
)
Add the new accounts backend to AUTHENTICATION_BACKENDS
AUTHENTICATION_BACKENDS = (
...
'django.contrib.auth.backends.ModelBackend',
...
)
Add the following to urls.py
urlpatterns = [
...
path('accounts/', include('accounts.urls', namespace='accounts')),
...
]
Documentation
All settings are handled with a PLATFORM_ACCOUNTS dictionary.
Example:
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.
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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b39c06fdb6ab8562259c2ac2f1b1c39b1f66016fb25d3434dbdbd4de3dcf634 |
|
MD5 | 346f91fd852bf862be448b8fe7a00d82 |
|
BLAKE2b-256 | 000a3a1f99195dc66f71e0114dc03477c4791c3f065f6754579129af2267a3be |
Hashes for django_labs_accounts-0.3.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5eeb9ed41bf983124ff7c1adb8e0f9d910fb0d785779849524ddb15ff91d3000 |
|
MD5 | 34e0c0bb6bfc19038d0a010594b41274 |
|
BLAKE2b-256 | 3c66daa41a57636c3d1bda947c75a781ed3f77d47c22bcde27ca8e1b4305ef2f |