Metadata-Version: 2.1
Name: pixelate-redactor
Version: 0.4
Summary: Library that provides pixelation for image redaction
Home-page: https://github.com/Eradash/pixelate-redactor
Author: Vincent Poirier
Author-email: vincent.poirier@tlmgo.com
License: BSD
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires: pillow
Description-Content-Type: text/markdown

# pixelate-redactor

Redact images with pixels

Works with Python >= 2.6, Python >= 3.2.

## Installation

```bash
pip install pixelate-redactor
```

## Example

### `pixelate-redactor`

```bash
pixelate-redactor \
  --input=img/example_img_original.png \
  --output=img/example_img_redacted.png \
  --pixel-size=10 \
  --start-x=90 \
  --start-y=180 \
  --size-x=150 \
  --size-y=150
```


### `pixelate-redactor-boxes`

```bash
pixelate-redactor \
  --input=img/example_img_original.png \
  --output=img/example_img_redacted.png \
  --pixel-size=10 \
  --boxes=img/boxes.json
```


with `img/boxes.json`:

```json
{
  "__box_name_1__": {
    "px": 90,
    "py": 180,
    "sx": 150,
    "sy": 150
  },
  "__box_name_2__": {
    "px": 90,
    "py": 180,
    "sx": 150,
    "sy": 150
  }
}
```

(the values are the same, to keep the same result from the single box example)

* `px` -> Position X
* `py` -> Position Y
* `sx` -> Size X
* `sy` -> Size Y


### Results

From this:

![original](https://raw.githubusercontent.com/Eradash/pixelate-redactor/master/img/example_img_original.png)

To this:

![redacted](https://raw.githubusercontent.com/Eradash/pixelate-redactor/master/img/example_img_redacted.png)


