Skip to main content

Django app to obfuscate text data.

Project description

Build Status Coverage Status Codacy Badge BCH compliance Pypi

Django app to obfuscate text data.

Table of contents:


Tested with python 2.7, 3.4, 3.5, 3.6 and Django 1.9, 1.10, 1.11: Travis CI

How to install

To install the app run:

$ pip install django-obfuscate

or add it to the list of requirements of your project.

Then add ‘obfuscator’ to your INSTALLED_APPS.


Example usage

On you django project settings, configure the model names and field names to be obfuscated:

    'FIELDS': {
        'app_label.ModelClass1': ['field1', 'field2', 'field3'],
        'app_label.ModelClass2': ['field1'],
        // ...

Run the management command to start obfuscation:

$ python obfuscate

You can run the management command passing as arguments: a model class path and a list of fields to obfuscate (thus will ignore FIELDS setting):

$ python obfuscate --model=app_label.ModelClass1 --fields=field1, field2, field3

Settings reference


Default: obfuscator.utils.ObfuscatorUtils

Path to class where obfuscator methods are defined. By default, the class define tow obfuscator methods: * text - Obfuscate simple text data, respecting max-length field parameter; * email - Obfuscate email data. Only text before @ is obfuscated, respecting max-length field parameter.

This class also define an obfuscate method. This method use fields mapping (see FIELDS_MAPPING setting) to route the field type with the obfuscate method.

You can redefine this class by subclassing the default class and changing this setting to point to your class.



    models.CharField: 'text',
    models.TextField: 'text',
    models.EmailField: 'email'

Map django model field types with obfuscator methods.


Default: {}

Fields to be obfuscated and respective model class path. Must be a dict with keys as python dot notation to path where the models are declared and the values must be declared as lists of model fields.

If no value defined, the management command will do nothing.


    'contenttypes.ContentType': ['model', 'label'],
    // ...


MIT license, see the LICENSE file. You can use obfuscator in open source projects and commercial products.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-obfuscate-0.1.2.tar.gz (6.9 kB view hashes)

Uploaded source

Built Distribution

django_obfuscate-0.1.2-py2.py3-none-any.whl (11.3 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page