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_otplatest versionpip install ob_dj_otp -
Add "ob_dj_otp" to your
INSTALLED_APPSsetting like this:
# settings.py
INSTALLED_APPS = [
...
"ob_dj_otp.core.otp",
]
- 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 migrateto 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
-
Clone github repo
git clone [url] -
pipenv install --dev -
pre-commit install -
Run unit tests
pytest
2 maintainers
Metadata
2 maintainers
Release files for ob-dj-otp 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ob-dj-otp-0.1.1.tar.gz | 55.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ob_dj_otp-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 75.2 kB
Release files / ob-dj-otp-0.1.1.tar.gz
| Download URL | ob-dj-otp-0.1.1.tar.gz |
|---|---|
| Size | 55.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f645101deeea99e43bfb52aeffcbe10975e082a344fe60418f27a77fa633bdc
|
|
BLAKE2b-256 checksum How to use checksums |
30ba5c838507387e18598a378019656ac0671e0abe02df24dc4d77a982f6a010
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / ob_dj_otp-0.1.1-py3-none-any.whl
| Download URL | ob_dj_otp-0.1.1-py3-none-any.whl |
|---|---|
| Size | 19.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
435494634a463cafb8d8ebac3f1721c541645fb4b33c0940cc68ee6e32b594da
|
|
BLAKE2b-256 checksum How to use checksums |
525263ddb5d97f9a9c2581362b4b516a4283cdd0534a1773108acf848f771535
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
