Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Django app to obfuscate text data.

Project Description

Django app to obfuscate text data.

Table of contents:

Compatibility

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.

INSTALLED_APPS = [
    ...
    'obfuscator',
]

Example usage

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

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

Run the management command to start obfuscation:

$ python manage.py 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 manage.py obfuscate --model=app_label.ModelClass1 --fields=field1, field2, field3

Settings reference

OBFUSCATOR_CLASS

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.

FIELDS_MAPPING

Default:

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

Map django model field types with obfuscator methods.

FIELDS

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.

Example:

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

License

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

Release History

This version
History Node

0.1.2

Download Files

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

File Name & Hash SHA256 Hash Help Version File Type Upload Date
django_obfuscate-0.1.2-py2.py3-none-any.whl
(11.3 kB) Copy SHA256 Hash SHA256
py2.py3 Wheel Sep 16, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting