Metadata-Version: 2.4
Name: privylayer-images
Version: 1.3.5
Summary: A Zero-Exposure Visual Privacy Buffer for VLMs.
Author: Nithish
License: MIT
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: opencv-python
Requires-Dist: easyocr
Requires-Dist: pyahocorasick
Dynamic: license-file

# PrivyLayer-Images

A Seperate Upgraded Feature from Privylayer (text based masking)

**A Zero-Exposure Visual Privacy Buffer for Vision-Language Models (VLMs).**

PrivyLayer is a high-performance, lightweight Python library designed to intercept, detect, and permanently mask sensitive visual data before it ever leaves your local host machine. Built for modern AI workflows, it ensures developers can leverage advanced external VLMs without compromising data sovereignty.

---

## 🚀 Features

* **Zero Data Exposure:** Raw sensitive visual data never leaves your local environment.
* **Targeted Document Detection:** Specialized computer vision models to identify highly sensitive identity documents like Aadhaar cards, PAN cards, and Passports.
* **Irreversible Masking:** Applies permanent black-box overlays to confidential regions. Once processed, the original image cannot be reconstructed.
* **Hardware Optimized:** Designed to leverage dedicated GPUs for parallel processing and real-time inference.
* **Typo-Protected Installation:** Safely alias-protected on PyPI to prevent typosquatting and accidental wrong installs.

---

## 📦 Installation

PrivyLayer requires Python 3.x and a dedicated GPU environment for optimal performance. 

Install the official package via pip:
```bash
pip install privylayer-images

```

*Note: We also maintain the alias `pip install privylayer-image` to catch typos. Both commands will safely install the official library.*

---

## 💻 Quick Start & Usage

Using PrivyLayer requires minimal code to integrate into your existing pipeline. use (privyimage) for importing

```python
import privyimage as pi

# Define the path to your raw, sensitive image
#(supported types: .JPG , .PNG , .WEBP)

img_file_path = "example_aadhaar.jpg"

# Execute the irreversible visual mask
# This will detect the document, apply the black box, and save/return the safe image
pi.mask_img(img_file_path)

```

---

## ⚙️ Core Workflow

PrivyLayer operates on a strict, four-stage localized pipeline:

1. **Input:** The system locally intercepts raw visual data (image uploads, document scans) prior to network transmission.
2. **Targeted Detect:** The engine scans the input to isolate confidential document structures and sensitive identity layouts.
3. **Images are Irreversible:** The visual sanitization process is strictly a one-way pipeline. Once masked, the original visual state cannot be reconstructed.
4. **Masks:** Permanent black box overlays are applied directly onto the detected confidential information, completely obscuring the sensitive pixels before the image is sent out. The masked image is saved in your folder / server to send to the LLM

---

## 📊 Performance Benchmarks

PrivyLayer is engineered for speed and compliance, requiring zero external network calls for the sanitization process.

| Hardware Configuration | Latency Performance |
| --- | --- |
| **NVIDIA T4 GPU (Baseline)** | 2.5 – 4 seconds |
| **Higher-Tier GPUs (Enterprise)** | < 2 seconds |

**Infrastructure Impact:** Minimal operational overhead. Executes fast, localized pattern matching in real-time.

---

## 🛠️ Technical Requirements

To maintain low-latency localized processing and handle real-time computer vision workloads, the host system must meet the following infrastructure criteria:

* **GPU Acceleration:** Requires dedicated graphics hardware optimized for parallel image processing and computer vision workloads.
* **Minimum Requirement:** An NVIDIA T4 GPU (or equivalent) to ensure reliable, real-time document detection and instant black-box masking before data transmission.

---

## 🧑‍💻 About the Developer

Engineered by **Nithish**, a solo developer focused on programming, AI, and data security. PrivyLayer was created as an Atmanirbhar (indigenous) open-source privacy shield to dynamically detect and mask sensitive information, ensuring strict compliance for modern software stacks.

* **Dev Portfolio:** [Nithish](https://nithishprogrammer.github.io/Nithish/)
* **Website:** [PrivyLayer-images Web](https://nithish.qzz.io/release)

---

### License

This project is licensed under the MIT License.

```

```
