Skip to main content

🔐 Authentication routes as a service.

Project description

🔐 AR as a Service

Code style: black PyPI version

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.

djangorest-routes

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
  1. Add "djangorest_routes" to your INSTALLED_APPS setting:
    INSTALLED_APPS = [
        ...
        'rest_routes',
        'sotp',
    ]
  1. Set "rest_routes.User" to AUTH_USER_MODEL setting:
AUTH_USER_MODEL = "rest_routes.User"
  1. Set the length of the OTP code in your project settings, default is 6:
OTP_LENGTH = 8
  1. Include the OTP salt key in your project settings, do not expose this salt key:
SALT_KEY = "some-secured-salt-key-for-otp-hashing"
  1. Include the rest_routes URLs in your project urls.py:
    path('rest_routes/', include('rest_routes.urls')),
  1. Run python manage.py migrate to create the djangorest_routes models.

  2. See documentation for django-sotp.

  3. 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.

You may also want to follow the author on twitter.

License

Disclaimer: Everything you see here is open and free to use as long as you comply with the license. 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!

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

djangorest_routes-1.2.5.tar.gz (22.7 kB view details)

Uploaded Source

File details

Details for the file djangorest_routes-1.2.5.tar.gz.

File metadata

  • Download URL: djangorest_routes-1.2.5.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for djangorest_routes-1.2.5.tar.gz
Algorithm Hash digest
SHA256 4d5b6c22cde8a095049ac9516d52217b9ce5e2280c9b07023c86d2c44c48e851
MD5 ef0468be88eed84d310dd8c85a1edd7a
BLAKE2b-256 d6c44e528999109e9448d33a8f2bf022b2d55bd8a8e5e78dacdc7996a7317447

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page