Skip to main content

Command to anonymize sensitive data.

Project description

Django-Hattori

pypi

Command to anonymize sensitive data. This app helps you anonymize data in a database used for development of a Django project.

This app is based on Django-Database-Anonymizer, using Faker to anonymize the values.

Installation

Install using pip:

pip install django-hattori

Then add 'hattori' to your INSTALLED_APPS.

INSTALLED_APPS = [
    ...
    'hattori',
]

Important

You should only run the anonymize process in PRE or development environments. To avoid problems by default anonymization is disabled.

To enable you must add to settings ANONYMIZE_ENABLED=True

Usage

How to execute command:

./manage.py anonymize_db

Possible arguments:

  • -a, --app: Define a app you want to anonymize. All anonymizers in this app will be run. Eg. anonymize_db -a shop
  • -m, --models: List of models you want to anonymize. Eg. anonymize_db -m Customer,Product
  • -b, --batch-size: batch size used in the bulk_update of the instances. Depends on the DB machine, default use 500.

Writing anonymizers

In order to use the management command we need to define anonymizers.

  • Create a module anonymizers.py in the given django-app
  • An anonymizer is a simple class that inherits from BaseAnonymizer
  • Each anonymizer class is going to represent one model
  • An anonymizer has the following members:
    • model: (required) The model class for this anonymizer
    • attributes: (required) List of tuples that determine which fields to replace. The first value of the tuple is the fieldname, the second value is the replacer
    • get_query_set(): (optional) Define your QuerySet
  • A replacer is either of type str or callable
  • A callable replacer is a Faker instance or custom replacer.
  • All Faker methods are available. For more info read the official documentation Faker!

Example

from hattori.base import BaseAnonymizer, faker
from shop.models import Customer

class CustomerAnonymizer(BaseAnonymizer):
    model = Customer

    attributes = [
        ('card_number', faker.credit_card_number),
        ('first_name', faker.first_name),
        ('last_name', faker.last_name),
        ('phone', faker.phone_number),
        ('email', faker.email),
        ('city', faker.city),
        ('comment', faker.text),
        ('description', 'fix string'),
        ('code', faker.pystr),
    ]

    def get_query_set(self):
        return Customer.objects.filter(age__gt=18)

Extending the existing replacers with arguments

Use lambdas to extend certain predefined replacers with arguments, like min_chars or max_chars on faker.pystr:

('code', lambda **kwargs: faker.pystr(min_chars=250, max_chars=250, **kwargs)),

Important: don't forget the **kwargs!

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-hattori-0.2.1.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

django_hattori-0.2.1-py2.py3-none-any.whl (8.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-hattori-0.2.1.tar.gz.

File metadata

  • Download URL: django-hattori-0.2.1.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

File hashes

Hashes for django-hattori-0.2.1.tar.gz
Algorithm Hash digest
SHA256 6953d40881317252f19f62c4e7fe8058924b852c7498bc42beb7bc4d268c252c
MD5 236407160efec38fd53bbc39803be887
BLAKE2b-256 27f90087cf8ccbd57082082146c719c1afd9a3745e188bf483c225f275d4d197

See more details on using hashes here.

File details

Details for the file django_hattori-0.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: django_hattori-0.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

File hashes

Hashes for django_hattori-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e529ed7af8fc34a0169c797c477672b687a205a56f3f5206f90c260acb83b7ac
MD5 f8267436dc8b4d829e70d268518c64b2
BLAKE2b-256 f483705362cb906746bddb6213f6cd67930f5329852f58e89403dc5ad3640be3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page