OBytes django application for managing OTP (OneTruePairing) for authentication, registration and changing phone number.
Project description
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
-
Install
ob_dj_otp
latest versionpip install ob_dj_otp
-
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")
- Include the OTP URLs in your project urls.py like this::
# urls.py
path("otp/", include("ob_dj_otp.apis.otp.urls")),
- 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
-
Clone github repo
git clone [url]
-
pipenv install --dev
-
pre-commit install
-
Run unit tests
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ob-dj-otp-0.0.18.tar.gz
(58.9 kB
view hashes)
Built Distribution
ob_dj_otp-0.0.18-py3-none-any.whl
(17.3 kB
view hashes)
Close
Hashes for ob_dj_otp-0.0.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9caa7a1f148cbac5fcde3dec917503b08fb1e773541de9f8964178d3607cf44 |
|
MD5 | cf000591ba2e973bca097c5db64bbb8c |
|
BLAKE2b-256 | 410dff00709d984dd4d7ba4292de80a706f619deb0027f0a8b1403f61fc35fa0 |