redact-cli-py | Update to v0.2.2 (#1006)

* Add support for One Page PDF and selective label redacting

* redact-cli-py | Add requirements.txt

* Bump version to v0.2.2

Co-authored-by: TFR258 <threis@microsoft.com>
Co-authored-by: Chia-Sheng Chen <chiache@microsoft.com>

Author: 3 people

scripts/redact_cli_py/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.2] - 2021-11-17
+### Added
+- Support to only redact specific labels.
+- Add support for one page pdfs in batch redact CLI (`batch_redact.py`)
+
 ## [0.2.1] - 2021-08-05
 ### Added
 - Support to image modes other than 'RGB' and 'RGBA'. E.g. image mode '1'.

scripts/redact_cli_py/Pipfile

@@ -9,6 +9,7 @@ jsonpointer = "*"
 shapely = "*"
 dacite = "*"
 azure-storage-blob = "*"
+pypdfium = "*"
 
 [dev-packages]
 pytest = "*"

scripts/redact_cli_py/Pipfile.lock

@@ -11,7 +11,7 @@ The OCR.json and labels.json will also be redacted while keeping the semantics o
 ![labels-before-after-redaction](./images/labels-before-after-redaction.png)
 
 ## Version
-Redact CLI 0.2.1
+Redact CLI 0.2.2
 
 ## Setup Environment
 
@@ -63,7 +63,12 @@ pip install pipenv
 cd redact_cli_py/
 pipenv install
 ```
+---
+**NOTE**
 
+If running into any errors, try running the above commands from an elevated Powershell terminal.
+
+---
 
 ## Run
 
@@ -104,6 +109,34 @@ python redact.py ocr <ocr_result_path> <fott_label_path> <output_path>
 python redact.py fott <fott_label_path> <output_path>
 ```
 
+### Redact specific labels from Image, OCR results or FOTT Label Path
+In some specific use-cases, the need may arise to redact specific labels from an image, OCR results or/and FOTT Label Path.
+Labels to be redacted need to provided together in a string separated by commas.
+
+If a document holds the following labels:
+- Label_01
+- Label_02
+- Label_03
+- Label_04
+
+And _Label_01_ and _Label_04_ need to be redacted, the following commands can be leveraged:
+
+#### Redact specific labels from Image
+
+``` bash
+python redact.py image <fott_label_path> <output_path> "Label_01,Label_04"
+```
+#### Redact specific labels from OCR Result
+
+``` bash
+python redact.py ocr <ocr_result_path> <image_path> <fott_label_path> <output_path> "Label_01,Label_04"
+```
+#### Redact specific labels from FOTT Label Path
+
+``` bash
+python redact.py image <image_path> <fott_label_path> <output_path> "Label_01,Label_04"
+```
+
 ### Batch Redaction
 Batch redaction supports redacting a folder rather than executing on a single file. Both the input and the output supports two sources:
 1. local folder: a path to a folder on your local machine.
@@ -116,7 +149,7 @@ python batch_redact.py <input_container> <input_folder_path> <output_container>
 #### Container
 You can provide one of the two options:
 1. `local`: this means you read/write data from local machine.
-2. `https://<blob_account_url>/<container_name>?<sas_token>`: this means you read/write data from the the container `container_name` of the Azure blob account `blob_account_url`. Please make sure your `sas_token` grants the correct access (Read/List for input, Read/Add/Create/Write/Delete/List for output).
+2. `https://<blob_account_url>/<container_name>?<sas_token>`: this means you read/write data from the container `container_name` of the Azure blob account `blob_account_url`. Please make sure your `sas_token` grants the correct access (Read/List for input, Read/Add/Create/Write/Delete/List for output).
 
 #### Examples
 
@@ -146,6 +179,18 @@ python batch_redact.py "https://my.blob.account/data?<my_secret_SAS_token>" fold
 2. Visit [Create Your SAS tokens with Azure Storage Explorer](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers) to see how to create a SAS token for this program to use.
 3. Currently, this redact CLI only support ASCII character redaction (Latin alphabets without the accent marks).
 
+#### PDF Support
+
+Batch mode now supports redacting data from one-page PDF documents. The tool will detect any PDF document in the input folder, convert to an image (.png) and redact the image itself placing it in the specified output folder upon completion.
+
+#### Batch Redacting specific labels
+
+Like the single file `redact.py` script, `batch_redact.py` supports redacting specific labels. Labels to be redacted need to provided together in a string separated by commas.
+``` bash
+python batch_redact.py local raw/ local redacted/ "Label_01,Label_02"
+```
+
+
 ### Test
 
 To run the unit tests, simply run