Skip to main content

A custom user model for django authentication

Project description

Django custom user model

A Custom User model for authentication

Requirement

  • Python (+3.5)
  • Django (+2.0)

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 verification 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'
sms verification config
KAVENEGAR_API = '<your api>'
RECEPTOR = '<your receptor>'

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
   # ...
]

Run django shell

in root directory (windows)

py manage.py shell

linux

$ python3 manage.py shell 

in shell

from CustomAuth.models import User
user = User.objects.create(cellphone='<valid email>', password='<your password>')
user.get_magic_link

JWT Authentication

For get new jwt token with 2 month expire time.

curl -H "jwt-authentication:<your token>" -X GET <your host>/jwt/new

for logged in user.

curl -X GET <your host>/jwt/new

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

https://<your_domain>/user/list/ # redirect to all user
https://<your_domain>/user/list/all # all user
https://<your_domain>/user/list/superuser # superuser
https://<your_domain>/user/list/staff # staff

Versioning

This project follows Semantic Versioning 2.0.0.

License

This project follows the BSD license. See the LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-custom-user-models, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size django_custom_user_models-0.1.2-py3-none-any.whl (588.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-custom-user-models-0.1.2.tar.gz (349.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page