Metadata-Version: 1.2
Name: django-data-masker
Version: 1.1.1
Summary: A simple Django app to mask sensitive data in forms.
Home-page: https://github.com/kcyeu/django-data-masker
Author: Kuo-Cheng Yeu
Author-email: kcyeu@mikuru.tw
License: MIT License
Description: ===========
        Data Masker
        ===========
        
        Data Masker is a simple Django app to do data masking. It masks sensitive data
        by name of form fields and is highly configurable. Currently `CharField <https://docs.djangoproject.com/en/dev/ref/forms/fields/#charfield>`_ and
        `EmailField <https://docs.djangoproject.com/en/dev/ref/forms/fields/#emailfield>`_ are supported.
        
        Quick start
        -----------
        
        1. Add ``data_masker`` to your INSTALLED_APPS setting like this::
        
            INSTALLED_APPS = [
                ...
                'data_masker',
            ]
        
        2. In template, pass the form which contains sensitive data to ``mask_form`` tag
           before any rendering tags.
        
        
        Example template
        ----------------
        
          .. code:: Django
        
            {# Load the tag library #}
            {% load data_masker %}
        
            {# Display a form #}
            <form action="/url/to/submit/" method="post" class="form">
              {% csrf_token %}
              {# Mask the form #}
              {% mask_form form as masked_form %}
              {{ masked_form }}
        
              {# It also works well with django-bootstrap #}
              {% comment %}
              {% bootstrap_form masked_form %}
              {% endcomment %}
              
              <button type="submit">Submit</button>
            </form>
            
        Settings
        --------
        django-data-masker has some pre-configured settings which can be modified by adding variables with ``DATA_MASKER_`` prefix in your ``settings.py`` and customizing the values you want.
        
        +-----------------------------+---------------------------------------------------+---------------------------------------------+
        | Variable                    | Usage                                             | Default                                     |
        +=============================+===================================================+=============================================+
        | DATA_MASKER_CLEAR_HEADING   | Number of heading characters to leave untouched   | 2                                           |
        +-----------------------------+---------------------------------------------------+---------------------------------------------+
        | DATA_MASKER_CLEAR_TAILING   | Number of tailing characters to leave untouched   | 2                                           |
        +-----------------------------+---------------------------------------------------+---------------------------------------------+
        | DATA_MASKER_MASK_FULL_EMAIL | Mask full email address including domainname part | False                                       |
        +-----------------------------+---------------------------------------------------+---------------------------------------------+
        | DATA_MASKER_FIELD_LIST      | List of field name to mask                        | ['account_name', 'account_number', 'email'] |
        +-----------------------------+---------------------------------------------------+---------------------------------------------+
        
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
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
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
