Metadata-Version: 1.1
Name: django-phone-verify
Version: 0.2.0
Summary: A Django app to support phone number verification using OTP sent via SMS.
Home-page: https://github.com/CuriousLearner/django-phone-verify
Author: Sanyam Khurana
Author-email: sanyam@sanyamkhurana.com
License: GPLv3
Description: django-phone-verify
        ===================
        
        .. image:: https://travis-ci.org/CuriousLearner/django-phone-verify.svg?branch=master
            :target: https://travis-ci.org/CuriousLearner/django-phone-verify
        
        A Django app to support phone number verification using security code / One-Time-Password (OTP) sent via SMS.
        
        Salient Features
        ----------------
        
        - Let's you verify phone numbers via SMS.
        - Extensibility to provide different length of tokens.
        - Comes with Twilio already integrated.
        - Set expiration time on tokens.
        - Provides 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 a number of potential cases, and not just auth.
        - Provides ready endpoints for sending SMS and verification (See `api_endpoints.md`_).
        
        .. _api_endpoints.md: phone_verify/docs/api_endpoints.rst
        
        Installation
        ------------
        
        .. code-block:: shell
        
            pip install django-phone-verify
        
        Usage
        -----
        
        - Add app to `INSTALLED_APPS`
        
        .. code-block:: python
        
            # In settings.py:
        
            # Add app to `INSTALLED_APPS`
            INSTALLED_APPS = [
                ...
                'phone_verify',
            ]
        
        - Add settings for Phone Verify as you desire:
        
        .. code-block:: python
        
            # Add settings for phone_verify to work
            PHONE_VERIFICATION = {
                'BACKEND': 'phone_verify.backends.twilio.TwilioBackend',
                'TWILIO_SANDBOX_TOKEN':'123456',
                'OPTIONS': {
                    'SID': 'fake',
                    'SECRET': 'fake',
                    'FROM': '+14755292729'
                },
                'TOKEN_LENGTH': 6,
                'MESSAGE': 'Welcome to {app}! Please use security code {otp} to proceed.',
                'APP_NAME': 'Phone Verify',
                'OTP_EXPIRATION_TIME': 3600  # In seconds only
            }
        
        - To explore more about how to use `Django Phone Verify`, have a look at `usage.rst`_
        
        .. _usage.rst: docs/usage.rst
        
        Compatibility
        -------------
        - Django 2.1+
        - Django REST Framework 3.9+
        
        Licence
        -------
        
        GPLv3
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
