Descope plugin for Django
Project description
Descope Django App
Descope is a user management and authentication platform. This plugin integrates Descope with your Django app.
Quick start
- Sign up for Descope and set admin roles
- Get your project id
- Create two roles in Descope, that will be mapped to Django permissions
- is_staff
- is_superuser
Map these roles to any user you would like to make a staff or superuser in your Django app. The names of these roles can be customized in the settings below.
- Install "django-descope" and add to your INSTALLED_APPS setting like this:
poetry add django-descope
OR
pip install django-descope
INSTALLED_APPS = [
...
'django_descope',
]
- Add Descope Middleware after the AuthenticationMiddleware and SessionMiddleware
MIDDLEWARE = [
...
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
...
'django_descope.middleware.DescopeMiddleware',
]
- Include descope URLconf in your project urls.py like this:
path('auth/', include('django_descope.urls')),
- In your site templates, insert the
descope_flow
tag where you want to place your flow
{% load descope %}
<!-- load the descope registry -->
{% if user.is_authenticated %}
<h1>Welcome {{ user.email }} you are logged in!</h1>
<p><a href="{% url 'logout' %}">Log Out</a></p>
{% else %} {% descope_flow "sign-up-or-in" "/" %}
<!-- provide the descope flow id, and where to redirect after a successful login-->
{% endif %}
- Start the development server and visit the newly created view
Settings
The following settings are available to configure in your project settings.py
Required
DESCOPE_PROJECT_ID
Optional
DESCOPE_MANAGEMENT_KEY
DESCOPE_IS_STAFF_ROLE
DESCOPE_IS_SUPERUSER_ROLE
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
Close
Hashes for django_descope-0.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e25d6f9a18d1e7894da3abfe5d2da85c2fb3cc88bf2f0efe9b040c7be30b9619 |
|
MD5 | 3777a5f0fc831e41901ad6be115cc7bc |
|
BLAKE2b-256 | 72249fccd4a19645f910a9ac40c59202b3291ef29152350d40eee798cef65ceb |