A custom user model for django authentication
Project description
Django custom user model
A Custom User model for authentication
Requirement
- Python (3.5, 3.6, 3.7, 3.8)
- Django (1.11, >2.0, 2.1, 2.2, 3.0, 3.1)
Installation
Install using pip
pip install django-custom-user-models
Add to INSTALLED_APPS
setting
INSTALLED_APPS = {
...
'CustomAuth',
...
}
Set AUTH_USER_MODEL
setting before first migrate
AUTH_USER_MODEL = 'CustomAuth.User'
Migrate apps
py manage.py migrate
Usage
Status Handler
Add handler
to yourproject/urls.py
from CustomAuth.urls import handler400, handler401, handler403, handler404, handler500
Authentication template
Add to settings.py
profile url
USER_PROFILE_URL = '<your user profile url>' # default '/profile/'
login redirect url
LOGIN_REDIRECT_URL = '<your login redirect>' # default '/account/profile/'
logout redirect url
LOGOUT_REDIRECT = '<your logout redirect>' # default '/'
signup successfully redirect
SIGNUP_SUCCESSFULLY_URL = '<your signup successfully redirect url>' # default '/profile/'
verification successfully redirect
VERIFY_SUCCESSFULLY = '<your verify successfully redirect url>' # default '/profile/'
verification failed redirect
VERIFY_FAILED = '<your verify failed redirect url>' # default 'Verification link is invalid!'
Email config
For verify email you should config email smtp server, example(gmail):
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_PORT = 587
EMAIL_HOST_USER = 'your name@gmail.com'
EMAIL_HOST_PASSWORD = 'your password'
EMAIL_USE_TSL = True
DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
EMAIL_FROM = EMAIL_HOST_USER
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
Magic Link
Use magic link for auto authentication user.
Add to settings.py
AUTHENTICATION_BACKENDS = (
# ...
'CustomAuth.backends.MagicLinkBackend', # magic backend
# ...
)
MIDDLEWARE = [
# ...
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
# ...
'CustomAuth.middleware.magic.MagicMiddleware', # Magic middleware
# ...
]
JWT Authentication
For get new jwt token with 2 month expire time.
curl -H "jwt-authentication:<your token>" -X GET <your host>/jwt/token
For authenticate with jwt use your token.
curl -H "jwt-authentication:<your token>" -X GET <your host>/<relative path>
Multi database handling
For save user in multiple databases:
AUTH_DATABASES = ['first database name', 'second database name', ... ]
Table show
Add django_tables2
to INSTALLED_APPS and make sure that django.template.context_processors.reques
is added to the context_processors in your template setting OPTIONS
Versioning
This project follows Semantic Versioning 2.0.0.
License
This project follows the BSD license. See the LICENSE for details.
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-custom-user-models-0.0.83.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3a6fd14c6a5af6c51b871db2b48c599492778c0f9de29ebed164bfef0ccab39 |
|
MD5 | 20d3c11860844b1a56c4e276c2352421 |
|
BLAKE2b-256 | 1f075684877ff30af53085b2b3eb4c323ae8b7856f78fca4f7a242871db1820b |
Hashes for django_custom_user_models-0.0.83-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30ab6a384e24c6ef4f7daaa97fb6e3940cd163a0c8dd977ae67d0c0ab1ff46db |
|
MD5 | 40e856f6ba555ac09906bd00140ba328 |
|
BLAKE2b-256 | c1f349bdf1cb76e37c819d216ea220ca1b4ff379cd1ade731ffaec06d6dd76d7 |