Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aybruhm/djangorest-routes
🔐 Authentication routes as a service.
https://github.com/aybruhm/djangorest-routes
django django-rest-framework django-rest-routes djangorest-routes hacktoberfest python
Last synced: 11 days ago
JSON representation
🔐 Authentication routes as a service.
- Host: GitHub
- URL: https://github.com/aybruhm/djangorest-routes
- Owner: aybruhm
- License: mit
- Created: 2022-03-02T08:16:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-05T21:32:26.000Z (about 2 years ago)
- Last Synced: 2024-05-18T17:50:57.540Z (6 months ago)
- Topics: django, django-rest-framework, django-rest-routes, djangorest-routes, hacktoberfest, python
- Language: Python
- Homepage:
- Size: 448 KB
- Stars: 22
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-django-rest-framework - djangorest-routes
README
# 🔐 AR as a Service
[](https://github.com/psf/black)
[](https://badge.fury.io/py/djangorest-routes)
An authentication library strongly built in Python (Django and Django Rest Framework). It serves the purpose of quick bootstrapping a project's authentication infrastructure.
Abstract
-----------
A reliable and trustworthy authentication library made for anyone who's a tinkerer and wants to get their personal or professional project authentication infrastructure built in no time.
Routes
---------
Here are it's key features:
- register
- login (jwt)
- login (refresh jwt)
- confirm otp
- resend otp code
- logout
- change password
- reset password otp (otp)
- reset password otp confirm (otp)
- reset password otp complete (otp)
- suspend user
Requirements
---------------
* Python (3.6, 3.7, 3.8, 3.9, 3.10)
* Django (2.2, 3.0, 3.1, 3.2, 4.0)
Quick Start
-----------
1. Install using `pip`:
```
pip install djangorest-routes
```
2. Add "djangorest_routes" to your INSTALLED_APPS setting:
```
INSTALLED_APPS = [
...
'rest_routes',
'sotp',
]
```
3. Set "rest_routes.User" to AUTH_USER_MODEL setting:
```
AUTH_USER_MODEL = "rest_routes.User"
```
4. Set the length of the OTP code in your project settings, default is `6`:
```
OTP_LENGTH = 8
```
5. Include the OTP salt key in your project settings, do not expose this salt key:
```
SALT_KEY = "some-secured-salt-key-for-otp-hashing"
```
6. Include the rest_routes URLs in your project urls.py:
```
path('rest_routes/', include('rest_routes.urls')),
```
7. Run ``python manage.py migrate`` to create the `djangorest_routes` models.
8. See [documentation](https://github.com/israelabraham/django-sotp#readme) for django-sotp.
9. Start the development server and visit http://127.0.0.1:8000/rest_routes/
Documentation & Support
--------------------------
Full documentation for the project is available at [docs](https://djangorest-routes.digitalstade.com/).
You may also want to follow the author on [twitter](https://twitter.com/israelabraham_).
License
---------
Disclaimer: Everything you see here is open and free to use as long as you comply with the [license](https://github.com/israelabraham/djangorest-routes/blob/main/LICENSE.txt). There are no hidden charges. We promise to do our best to fix bugs and improve the code.
Gratitude
----------
Special thanks goes to the beautiful brains of the below listed packages. From your works, I tinkered and came up with something that works best for me! I'll forever be grateful!
- [django](https://github.com/django/django)
- [djangorestframework](https://github.com/encode/django-rest-framework)
- [djangorestframework-simplejwt](https://github.com/jazzband/djangorestframework-simplejwt)
- [drf-yasg](https://github.com/axnsan12/drf-yasg)
- [rest-api-payload](https://github.com/israelabraham/api-payload)
- [django-sotp](https://github.com/israelabraham/django-sotp)