django-phone-verify 3.0.1

A Django app to support phone number verification using security code sent via SMS.

A Django app to support phone number verification using the security code sent via SMS.

Salient Features

• Let’s devs verify phone numbers via SMS.

• Extensibility to provide tokens with varying lengths.

• Comes with Twilio and Nexmo already integrated.

• Set expiration time on tokens.

• Provides an interface for writing custom SMS sending backend for easy extensibility.

• Does not mess up with existing AUTH_USER_MODEL at all.

• Can be used for several potential use-cases, and not just auth.

• Provides ready endpoints for sending SMS and verification (See api_endpoints.rst).

Installation

pip install django-phone-verify[all]

You also have option to install only the required dependencies for Twilio or Nexmo:

pip install django-phone-verify[twilio]
pip install django-phone-verify[nexmo]

Configuration

• Add app to INSTALLED_APPS

# In settings.py:

# Add app to `INSTALLED_APPS`
INSTALLED_APPS = [
    ...
    "phone_verify",
    ...
]

• Add settings for Phone Verify as you desire:

# In settings.py
# Add settings for phone_verify to work
PHONE_VERIFICATION = {
    "BACKEND": "phone_verify.backends.twilio.TwilioBackend",
    "OPTIONS": {
        "SID": "fake",
        "SECRET": "fake",
        "FROM": "[phone]",
        "SANDBOX_TOKEN": "123456",
    },
    "TOKEN_LENGTH": 6,
    "MESSAGE": "Welcome to {app}! Please use security code {security_code} to proceed.",
    "APP_NAME": "Phone Verify",
    "SECURITY_CODE_EXPIRATION_TIME": 3600,  # In seconds only
    "VERIFY_SECURITY_CODE_ONLY_ONCE": False,  # If False, then a security code can be used multiple times for verification
}

Usage

• To explore more about how to use, integrate and leverage the existing functionality of Django Phone Verify, have a look at getting_started.rst

Note: Django Phone Verify also provides Nexmo as a backend service other than Twilio. To switch to Nexmo, replace BACKEND within your PHONE_VERIFICATION setting with phone_verify.backends.nexmo.NexmoBackend and define KEY within OPTIONS of PHONE_VERIFICATION setting, with your Nexmo API key, in place of already available SID.

Compatibility

• Python 3.6+

• Django 2.1+

• Django REST Framework 3.9+

Contributing

No code is bug-free and I’m sure this app will have bugs. If you find any bugs, please create an issue on GitHub.

Licence

GPLv3

Changelog

See changelog.rst