Metadata-Version: 2.4
Name: privato
Version: 0.1.4
Summary: To Identify and Redact Personal Identifiable information
Author-email: Mohammed Saajid <mohammedsaajid23@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/Mohammed-Saajid/privato
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: fastapi>=0.103.0
Requires-Dist: uvicorn
Requires-Dist: pydantic>=2.0.0
Requires-Dist: requests>=2.32.0
Requires-Dist: loguru>=0.7.0
Requires-Dist: joblib>=1.2.0
Requires-Dist: scikit-learn>=1.1.3
Requires-Dist: pandas>=2.2.3
Requires-Dist: httpx>=0.27.0
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: presidio-image-redactor>=0.0.57
Requires-Dist: pymupdf>=1.26.3
Requires-Dist: pdf2image>=1.17.0
Requires-Dist: presidio-anonymizer>=2.2.359
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: ultralytics>=8.3.10
Requires-Dist: supervision>=0.26.1
Requires-Dist: huggingface-hub>=0.34.4
Requires-Dist: onnxruntime>=1.18.0
Requires-Dist: onnx>=1.17.0
Requires-Dist: presidio-structured>=0.0.6
Requires-Dist: typer>=0.9.4
Provides-Extra: dev
Requires-Dist: pytest>=7.2; extra == "dev"
Requires-Dist: black>=24.3; extra == "dev"
Requires-Dist: autopep8>=2.0.0; extra == "dev"
Requires-Dist: ipdb>=0.13.0; extra == "dev"
Requires-Dist: pylint>=3.0.0; extra == "dev"
Requires-Dist: reportlab>=4.4.3; extra == "dev"
Requires-Dist: mkdocs>=1.6.1; extra == "dev"
Requires-Dist: mkdocs-material>=9.6.20; extra == "dev"
Requires-Dist: mkdocstrings[python]>=0.30.1; extra == "dev"

# Privato

Privato is a SDK for building secure and privacy-focused applications. It provides tools and libraries to help developers create applications that analyze and redact personal identifiable information (PII).

Privato provides both an API, CLI and a web interface for easy interaction.

## Features

- PII Detection: Identify and classify various types of PII in text data.
- Redaction: Automatically redact sensitive information to protect user privacy.
- Customizable: Extend and customize the detection and redaction capabilities to fit specific needs.
- Easy Integration: Simple API for seamless integration into existing applications.
- Web Interface: User-friendly web interface for manual review and redaction.

## Installation
You can install Privato using pip:

```bash
pip install privato
```

## Usage
Here's a simple example of how to use Privato to detect and redact PII in text:

```py
from privato.core.redactor import Redactor

text = "John's email is john.doe@example.com and his phone number is (123) 456-7890."
redactor = Redactor()
redacted_text = redactor.redact_text(text)['text']
print(redacted_text)
```
This will output:
```
"<PERSON>'s email is <EMAIL_ADDRESS> and his phone number is <PHONE_NUMBER>."
```

## Web Interface
To run the Backend, use the following command:

```bash
privato api run
```

Then, open your browser and go to `http://127.0.0.1:8080`.


## Make Commands
- `make help`: List all available make commands.
- `make install`: Install the required dependencies.
- `make install-dev`: Install development dependencies.
- `make test`: Run the test suite.
- `make run`: Start the FastAPI Development server.
- `make clean`: Remove temporary files and directories.
- `make deploy`: Build and run the Docker container.
- `make down`: Stop and remove the Docker container.


## Docs
For more detailed documentation, visit the [Privato Documentation](https://mohammed-saajid.github.io/Privato/).
