Presidio image redactor package
Project description
Presidio Image Redactor
Please notice, this package is still in alpha and not production ready.
Description
The Presidio Image Redactor is a Python based module for detecting and redacting PII text entities in images.
Installation
Pre-requisites:
-
Install Tesseract OCR by following the instructions on how to install it for your operating system.
The Image-Redactor was tested with a minimal version of 4.0.0
As package:
To get started with Presidio-image-redactor, run the following:
pip install presidio-image-redactor
Once Installed, run the following command to download the default spacy model needed for Presidio Analyzer:
python -m spacy download en_core_web_lg
Getting started
The engine will receive 2 parameters:
- Image to redact.
- Color fill to redact with, by default color fill will be black. Can either be an int or tuple (0,0,0)
from PIL import Image
from presidio_image_redactor import ImageRedactorEngine
# Get the image to redact using PIL lib (pillow)
image = Image.open("ocr_text.png")
# Initialize the engine
engine = ImageRedactorEngine()
# Redact the image with pink color
redacted_image = engine.redact(image, (255, 192, 203))
# save the redacted image
redacted_image.save("new_image.png")
# open the image for viewing
redacted_image.show()
As docker service:
In folder presidio/presidio-image-redactor run:
docker-compose up -d
HTTP API
redact
Receives an image and color fill (optional, default is black). Redact the image PII text and returns a new redacted image.
POST /redact
Payload:
Sent as multipart-form. Contains image file and data of the required color fill.
{
"data": "{'color_fill':'0,0,0'}"
}
Result:
200 OK
curl example:
# use ocr_test.png as the image to redact, and 255 as the color fill.
# out.png is the new redacted image received from the server.
curl -XPOST "http://localhost:3000/redact" -H "content-type: multipart/form-data" -F "image=@ocr_test.png" -F "data=\"{'color_fill':'255'}\"" > out.png
Python script example can be found under: /presidio/e2e-tests/tests/test_image_redactor.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for presidio_image_redactor-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b969a14794236682dcd3c3982802c8a5844e3801195f09fa17193638667b7061 |
|
MD5 | 5d7d90a7cf6ac86c7508e0fa9844e1fb |
|
BLAKE2b-256 | 72d37a636119405337d7241268126de87e658cca7b761bace86b81f90c6d322a |