image-anonymizer 0.2.8

A command-line tool to detect and mask sensitive content in images
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# Image Anonymizer

![Image Anonymizer Header](title_header.svg)

A command-line tool to detect and mask sensitive content in images.

## Features
- Detects and masks sensitive content in images:
  - Text detection via OCR
  - Face detection and masking
- Identifies sensitive textual information like:
  - API keys
  - Email addresses
  - Phone numbers
  - Credit card numbers
  - Personal names
  - Company or service names
- Masks detected content with colored rectangles
- Applies mosaic effect to faces to protect privacy
- Outputs processed images to a specified directory

## Installation
```
cargo install image-anonymizer
```

## Configuration
The application requires API keys to access Google Cloud Platform services. Create a `.env` file in the root directory based on the `.env.template` file:
```
# You need to set these environment variables
# GCP API Key for Google Cloud Platform need to access "Gemini for Google Cloud API", "Generative Language API" and "Cloud Vision API"
GCP_API_KEY=
GEMINI_MODEL=gemini-2.0-flash-lite
```
Fill in your GCP API key to enable text and face detection capabilities.

## Usage
```
image-anonymizer [OPTIONS] <INPUT_FILE>
Options:
  -o, --output-dir <DIR>     Output directory for processed images [default: ./output]
  -m, --mask-texts <TEXTS>   Additional texts to mask, comma separated
  -f, --mask-faces           Enable face detection and mosaic masking
  -h, --help                 Print help
  -V, --version              Print version
```

## Examples

### Text Masking

The tool can detect and mask sensitive text such as email addresses, API keys, and other personal information.

**Example 1**

![Screenshot with sensitive text](examples/masked_text1.png)

**Example 2**

![Screenshot with masked text](examples/masked_text2.png)

### Face Detection and Mosaic

The tool can automatically detect faces in images and apply a mosaic effect to protect privacy.

<table>
  <tr>
    <th>Before</th>
    <th>After</th>
  </tr>
  <tr>
    <td><img src="examples/face_before.jpg" width="400"></td>
    <td><img src="examples/face_after.jpg" width="400"></td>
  </tr>
</table>

### Command Examples

```bash
# Process a single image 
image-anonymizer screenshot.png

# Process an image and specify output directory
image-anonymizer --output-dir ./masked_images screenshot.png

# Process an image and mask additional text
image-anonymizer --mask-texts "secret,confidential" screenshot.png

# Process an image and apply mosaic to faces
image-anonymizer --mask-faces screenshot.png

# Process an image, mask both faces and specific text
image-anonymizer --mask-faces --mask-texts "confidential" screenshot.png
```

## Running Tests
```bash
# Run all tests excluding integration tests that require API keys
cargo test

# Run all tests including integration tests
# (requires valid API keys in .env)
cargo test -- --include-ignored

# Run specific test
cargo test test_mask_text_with_annotations

# Run tests with logging
RUST_LOG=debug cargo test
```

Note: Some tests require a valid GCP API key to be set in the environment or in a `.env` file. Tests that make API calls are marked as `#[ignore]` and can be run with the `--include-ignored` flag.

## License
This project is licensed under the MIT License - see the LICENSE file for details.