Authentication and Registration in Django Rest Framework
Project description
Dj-Rest-Auth
Drop-in API endpoints for handling authentication securely in Django Rest Framework. Works especially well with SPAs (e.g., React, Vue, Angular), and Mobile applications.
Requirements
- Django 2, 3, or 4 (See Unit Test Coverage in CI)
- Python 3
Quick Setup
Install package
pip install dj-rest-auth
Add dj_rest_auth app to INSTALLED_APPS in your django settings.py:
INSTALLED_APPS = (
...,
'rest_framework',
'rest_framework.authtoken',
...,
'dj_rest_auth'
)
Add URL patterns
urlpatterns = [
path('dj-rest-auth/', include('dj_rest_auth.urls')),
]
(Optional) Use Http-Only cookies
REST_AUTH = {
'USE_JWT': True,
'JWT_AUTH_COOKIE': 'jwt-auth',
}
Testing
Install required modules with pip install -r dj_rest_auth/tests/requirements.pip
To run the tests within a virtualenv, run python runtests.py from the repository directory.
The easiest way to run test coverage is with coverage,
which runs the tests against all supported Django installs. To run the test coverage
within a virtualenv, run coverage run ./runtests.py from the repository directory then run coverage report.
Tox
Testing may also be done using tox, which
will run the tests against all supported combinations of Python and Django.
Install tox, either globally or within a virtualenv, and then simply run tox
from the repository directory. As there are many combinations, you may run them
in parallel
using tox --parallel.
The tox.ini includes an environment for testing code coverage
and you can run it and view this report with tox -e coverage.
Linting may also be performed via flake8
by running tox -e flake8.
Documentation
View the full documentation here: https://dj-rest-auth.readthedocs.io/en/latest/index.html
Acknowledgements
This project began as a fork of django-rest-auth. Big thanks to everyone who contributed to that repo!
A note on Django AllAuth from @iMerica
This project has optional and very narrow support for Django-AllAuth. As the maintainer, I have no interest in making this package support all use cases in Django-AllAuth. I would rather focus on improving the quality of the base functionality or focus on OIDC support instead. Pull requests that extend or add more support for Django-AllAuth will most likely be declined. Do you disagree? Feel free to fork this repo!
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
File details
Details for the file dj-rest-auth-5.0.2.tar.gz.
File metadata
- Download URL: dj-rest-auth-5.0.2.tar.gz
- Upload date:
- Size: 217.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aad7d912476169e9991547bf98645344d3939be2d7052098048d819524c115d9 |
|
| MD5 | 039e71d0ecb9ba543488f9d472e5dfcc |
|
| BLAKE2b-256 | 600b344743248e8282e4355661d2e136fffbc80ceeeebe47f9c2c10eaf41dbca |
