Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 1.87 KB

index.rst

File metadata and controls

65 lines (47 loc) · 1.87 KB

Welcome to Django REST Registration's documentation!

User registration REST API, based on Django-REST-Framework.

install quickstart detailed_configuration/index cookbook/index

Requirements

  • Django (2.0+, 3.0+, 4.0+) and Django-REST-Framework (3.3+)
  • Python 3.6 or higher (no Python 2 support!)

Features

  • Supported views:
    • registration (sign-up) with verification
    • login/logout (sign-in), session- or token-based
    • user profile (retrieving / updating)
    • reset password
    • change password
    • register (change) e-mail
  • Views are compatible with django-rest-swagger
  • Views can be authenticated via session or auth token
  • Modeless (uses the user defined by settings.AUTH_USER_MODEL and also uses cryptographic signing instead of profile models)
  • Uses password validation
  • Heavily tested (Above 98% code coverage)

Current limitations

  • Supports only one email per user (as user model field)
  • No built-it JWT support (but you can easily implement one <generating-and-authenticating-using-jwt> or use Django REST Registration along libraries like django-rest-framework-simplejwt)

Indices and tables

  • genindex
  • search