Simple user registration package based on Django Rest Framework. DRF Registration - The easy way to generate registration RESTful APIs.
Project description
DRF Registration
Simple user registration package based on Django Rest Framework. DRF Registration - The easy way to generate registration RESTful APIs.
Check the document at https://drf-registration.readthedocs.io/
Requirements
- Django (>=2.0)
- Django REST Framework (>=3.8.2)
- Python (>=3.6)
Features
- Register
- Verify/activate account by token sent to email
- Login use token
- Logout
- User profile
- Change password
- Reset password
- Login by socials (Facebook, Google)
- Set password when login by social
- Sync user account with socials
- HTML email configuration
- Test coverage (98%)
Installation & Configuration
Install by use pip
:
pip install drf-registration
Add drf_registration
in INSTALLED_APPS
INSTALLED_APPS = [
...
'rest_framework',
'rest_framework.authtoken',
'drf_registration',
...
]
Include urls of drf_registration
in urls.py
urlpatterns = [
...
path('/api/accounts/', include('drf_registration.urls')),
...
]
Settings
Set AUTHENTICATION_BACKEND
for support login by multiple custom fields and check inactivate user when login:
AUTHENTICATION_BACKENDS = [
'drf_registration.auth.MultiFieldsModelBackend',
]
You can update login username fields by change LOGIN_USERNAME_FIELDS
in DRF_REGISTRATION
object. Default to ['username', 'email',]
.
- Set
DEFAULT_AUTHENTICATION_CLASSES
inREST_FRAMEWORK
configuration
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.TokenAuthentication',
],
}
Design settings
DRF_REGISTRATION = {
}
Check default settings here.
Base APIs Design
Assuming that base resource is /api/v1/accounts/
POST: /register/
: Register new userPOST: /verify/
: Verify account by emailPOST: /login/
: Login to the system use username/email and passwordPOST: /logout/
: Logout of the systemGET: /profile/
: Get user profilePUT: /profile/
: Update user profilePUT: /change-password/
: Change user passwordPUT: /set-password/
: Set user password when login with social account
Check more APIs Design at here.
Command line
Unit Test
make test
You can add ARGS="specific_folder/"
or ARGS="specific_file.py"
to run specific test cases.
Run pylint
make pylint
Build & run docs local server
make docs
Access docs server at http://localhost:8080
Clean
make clean
Project details
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 drf_registration-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eadc18d353e0c2c29f8d72cd4650d303c99b96ec4e8d48977666a67c2ab5216c |
|
MD5 | 10a7f16b169cb30522908a90281b8956 |
|
BLAKE2b-256 | ef47fa639e2138f4d8454d1ad460b6cbbbcd8a0c26954fb8a39076582f168bdb |