ob-dj-otp 0.0.10

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",
   ]
   # Setting Twilio as SMS Provider
   OTP_PROVIDER = os.environ.get("OTP_PROVIDER", "twilio")
   # Passing Twilio Verify Service-ID
   OTP_TWILIO_SERVICE = os.environ.get("OTP_PROVIDER")

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.

Extending API Serializers

OTP Verification serializer can be extended as following:

# utils.py
from ob_dj_otp.apis.otp.serializers import OTPVerifyCodeSerializer
from rest_framework import serializers

class NewOTPVerifyCodeSerializer(OTPVerifyCodeSerializer):
    # write_only is required to prevent errors when reading from OTP Object for the attr
    email = serializers.CharField(max_length=100, required=True, write_only=True)

    class Meta:
        fields = OTPVerifyCodeSerializer.Meta.fields + ("email",)
        model = OTPVerifyCodeSerializer.Meta.model

# add path to Serializer to django settings
OTP_VERIFICATION_SERIALIZER = "full.path.NewOTPVerifyCodeSerializer"

Developer Guide

1. Clone github repo git clone [url]

2. pipenv install --dev

3. pre-commit install

4. Run unit tests pytest