Metadata-Version: 2.1
Name: django-trench
Version: 0.2.1
Summary: REST Multi-factor authentication package for Django
Home-page: https://github.com/merixstudio/django-trench
Author: Merixstudio
Author-email: trench@merixstudio.com
License: MIT License
Description: =============
        django-trench
        =============
        
        .. image:: https://travis-ci.org/merixstudio/django-trench.svg?branch=master
          :target: https://travis-ci.org/merixstudio/django-trench
        
        .. image:: https://codecov.io/gh/merixstudio/django-trench/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/merixstudio/django-trench/
        
        .. image:: https://readthedocs.org/projects/django-trench/badge/?version=latest
           :target: https://django-trench.readthedocs.io/en/latest/?badge=latest
        
        
        | **django-trench** provides a set of REST API endpoints to supplement `django-rest-framework`_ with multi-factor authentication (MFA, 2FA). It supports both standard built-in authentication methods, as well as JWT (JSON Web Token). **django-trench** follows the url pattern developed in `djoser`_ library and may act as its supplement.
        | We deliver a couple of sample secondary authentication methods including sending OTP based code by email, SMS/text as well as through 3rd party mobile apps or utilising YubiKey. Developers can easily add own auth backend supporting any communication channel.
        
        Features
        --------
        
        * Easily plugable and compatible with `django-rest-framework`_ and `djoser`_
        * Allows user to pick an additional authentication method from range of backends defined by a developer. Read more: `backends`_
        * Comes out of a box with email, SMS, mobile apps and YubiKey support
        
        Requirements
        ------------
        
        Supported versions
        ******************
        
        * Python 3.4, 3.5, 3.6, 3.7
        * Django 1.11, 2.0, 2.1
        * Django REST Framework 3.8
        
        | If you implement ``djoser`` for authentication:
        
        * `djoser`_ >= 1.15.0
        
        | If you are going to use JWT authentication:
        
        * `django-rest-framework-jwt`_ >= 1.11.0
        
        | or
        
        * `djangorestframework-simplejwt`_ >= 3.3
        
        Quick Start
        -----------
        
        1. Install the package using pip:
        
        .. code-block:: python
        
            pip install django-trench
        
        or add it to your requirements file.
        
        2. Add ``trench`` library to INSTALLED_APPS in your app settings file:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...,
                'rest_framework',
                'rest_framework.authtoken',  # In case of implementing Token Based Authentication
                ...,
                'trench',
            )
        
        3. Run migrations
        
        | Read further in: `installation`_.
        
        Translation
        -----------
        
        Trench uses Transifex service to translate our package into other languages.
        
        We will appreciate your help with translation.
        
        https://www.transifex.com/merixstudio/django-trench/dashboard/
        
        
        Demo project
        ------------
        
        You can also check our live `demo`_.
        
        .. _backends: https://django-trench.readthedocs.io/en/latest/backends.html
        .. _installation: https://django-trench.readthedocs.io/en/latest/installation.html
        .. _demo: https://django-trench.readthedocs.io/en/latest/demo.html
        .. _django-rest-framework: http://www.django-rest-framework.org
        .. _djoser: https://github.com/sunscrapers/djoser
        .. _django-rest-framework-jwt: https://github.com/GetBlimp/django-rest-framework-jwt
        .. _djangorestframework-simplejwt: https://github.com/davesque/django-rest-framework-simplejwt
        
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
