ob-dj-otp 0.1.1

OBytes django application for managing OTP (OneTruePairing) for authentication, registration and changing phone number.

OBytes Django OTP App

OTP is a Django app to conduct Web-based one true pairing, for authentication, registration and changing phone number.

Quick start

1. Install ob_dj_otp latest version pip install ob_dj_otp

2. Add "ob_dj_otp" to your INSTALLED_APPS setting like this:

   # settings.py
   INSTALLED_APPS = [
        ...
        "ob_dj_otp.core.otp",
   ]

3. Include the OTP URLs in your project urls.py like this::

    # urls.py
    path("otp/", include("ob_dj_otp.apis.otp.urls")),

4. Run python manage.py migrate to create the otp models.

Configuration

OTP_FORCE_CODE Force using this code instead of generating random one, by default it's not setted

OTP_RETURN_USAGE Boolean that determine whether you want to usage in the response, by default is False

OTP_TIMEOUT Number of seconds for the code expirations, by default it's 3 minuts

OTP_USER_SERIALIZER For the registration purpuse, you need to specify th path to you user serializer so you can create the user with full data

OTP_AUTH_USAGE_ONLY Boolean that deactivate the registration

OTP_EMAIL_AS_PRIMARY_FIELD Boolean to make email required

OTP_PHONE_NUMBER_AS_PRIMARY_FIELD Boolean to make phone number required

SERIALIZERS_MIXIN Dict contain mixins paths to customize serializers behavior ( see tests for better overview)

Notifications

Since each project need it custom provider, the notification part should be sone on the project level not the package level, and it can be done easely but post_save on OneTruePairing model.

Developer Guide

1. Clone github repo git clone [url]

2. pipenv install --dev

3. pre-commit install

4. Run unit tests pytest