Skip to main content

Enterprise-grade reversible anonymization using Google Cloud DLP

Project description

Reversible Anonymizer

A Python package for reversible text anonymization using Google Cloud services.

Installation

bash pip install reversible-anonymizer

Prerequisites

Google Cloud project with the following services enabled:

Cloud DLP API (dlp.googleapis.com)

Cloud Firestore API (firestore.googleapis.com)
AI Platform API (aiplatform.googleapis.com)
Google Cloud credentials configured

Usage

from reversible_anonymizer import ReversibleAnonymizer

Initialize with default settings

anonymizer = ReversibleAnonymizer(project="your-project-id")

Or customize the settings

anonymizer = ReversibleAnonymizer( project="your-project-id", info_types=[ {"name": "PERSON_NAME"}, {"name": "EMAIL_ADDRESS"} ], collection_name="custom_mappings", location="us-central1" )

Anonymize text

original_text = "Hello, my name is John Doe" anonymized_text = anonymizer.anonymize(original_text) print(f"Anonymized: {anonymized_text}")

De-anonymize text

original_text = anonymizer.deanonymize(anonymized_text) print(f"De-anonymized: {original_text}")

Error Handling

The package provides custom exceptions:

ServiceNotEnabledError: Raised when required Google Cloud services are not enabled AnonymizationError: Raised when anonymization fails DeAnonymizationError: Raised when de-anonymization fails

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Create a test file:

tests/test_anonymizer.py:

import pytest
from reversible_anonymizer import ReversibleAnonymizer
from reversible_anonymizer.exceptions import ServiceNotEnabledError

def test_anonymizer_initialization():
    with pytest.raises(ServiceNotEnabledError):
        ReversibleAnonymizer("invalid-project")

def test_custom_info_types():
    anonymizer = ReversibleAnonymizer(
        "your-project-id",
        info_types=[{"name": "EMAIL_ADDRESS"}],
        check_services=False
    )
    assert anonymizer.info_types == [{"name": "EMAIL_ADDRESS"}]

# Add more tests as needed
To use the package:

Install the package:
pip install reversible-anonymizer
Use in your code:
from reversible_anonymizer import ReversibleAnonymizer

try:
    # Initialize with custom settings
    anonymizer = ReversibleAnonymizer(
        project="your-project-id",
        info_types=[
            {"name": "PERSON_NAME"},
            {"name": "EMAIL_ADDRESS"},
            {"name": "PHONE_NUMBER"}
        ],
        collection_name="custom_mappings"
    )

    # Anonymize text
    original_text = "Hello, my name is John Doe. Call me at 123-456-7890"
    anonymized_text = anonymizer.anonymize(original_text)
    print(f"Anonymized: {anonymized_text}")

    # De-anonymize text
    original_text = anonymizer.deanonymize(anonymized_text)
    print(f"De-anonymized: {original_text}")

except Exception as e:
    print(f"Error: {str(e)}")

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

reversible_anonymizer-1.0.9.tar.gz (46.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reversible_anonymizer-1.0.9-py3-none-any.whl (50.6 kB view details)

Uploaded Python 3

File details

Details for the file reversible_anonymizer-1.0.9.tar.gz.

File metadata

  • Download URL: reversible_anonymizer-1.0.9.tar.gz
  • Upload date:
  • Size: 46.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for reversible_anonymizer-1.0.9.tar.gz
Algorithm Hash digest
SHA256 73004cc4bbb9dab3c5e12668997d64c87e173cb533d4967e65473d3d8f08a8de
MD5 676a70e75561224c5e5d386410265e7f
BLAKE2b-256 9476f7b2d12148539dd8b4484d9b479350cb2735dfebf7026625237a3a1dd70d

See more details on using hashes here.

File details

Details for the file reversible_anonymizer-1.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for reversible_anonymizer-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 97225b961094e8bb396d38efb2cea3780524b41ed8e59a0e87151b03e60d6cc1
MD5 8892eaa362453f6ce0754ed1be052b86
BLAKE2b-256 0bad245f053af37aea233f22e8805b81d7d37528b8cd4b799a1772b0fd81e594

See more details on using hashes here.

Supported by

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