Metadata-Version: 2.5
Name: dpdpkit-pii
Version: 0.0.1a0
Summary: Find personal data in your databases and files: Indian PII recognizers (Aadhaar, PAN, GSTIN, UPI and more) and a read-only scanner.
Project-URL: Homepage, https://github.com/dpdpkit-dev/dpdpkit-pii
Project-URL: Documentation, https://dpdpkit-dev.github.io/dpdpkit-docs/dev/
Project-URL: Changelog, https://github.com/dpdpkit-dev/dpdpkit-pii/blob/main/CHANGELOG.md
Author: dpdpkit maintainers
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: data-discovery,dpdp,india,pii,presidio,privacy
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: dpdpkit-core<0.2,>=0.1.0a1
Provides-Extra: dev
Requires-Dist: mypy>=1.11; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Description-Content-Type: text/markdown

# dpdpkit-pii

Personal-data discovery for [dpdpkit](https://github.com/dpdpkit-dev). It will find personal data in your databases and files and compare it with your dpdpkit registry, reporting counts only.

> **Disclaimer.** dpdpkit is software that helps you implement obligations under India's Digital Personal
> Data Protection Act, 2023 and the DPDP Rules, 2025. It does not provide legal advice and does not
> guarantee compliance. Decisions about notices, purposes, retention and incident reporting must be made
> by you or your counsel.

## Status

**Not usable yet.** Version 0.0.1a0 is an empty pre-release that reserves the name on PyPI. The first working
release is planned for milestone v0.5 (planned for June 2027); the work is tracked as PII-01 to PII-08 in the dpdpkit task sheet.

Planned:

- Presidio recognizers for India: Aadhaar (with Verhoeff check), PAN, GSTIN, IFSC, UPI, mobile, voter ID, passport, vehicle registration, ABHA
- Column-name heuristics in English and Hinglish
- Read-only database scanner (SQLAlchemy inspection, capped sampling) and file scanner (CSV, JSON, Excel, text; folder or S3 prefix)
- Registry diff and reports (JSON, Markdown, HTML; counts only, never values)
- `dpdpkit scan` CLI and the `ghcr.io/dpdpkit-dev/scanner` image

Until then, use [`dpdpkit-fastapi`](https://github.com/dpdpkit-dev/dpdpkit-fastapi) or the core library
[`dpdpkit-core`](https://github.com/dpdpkit-dev/dpdpkit-core). Documentation:
https://dpdpkit-dev.github.io/dpdpkit-docs/dev/

## License

Apache-2.0. See [LICENSE](LICENSE). Contributions need a DCO sign-off; see [CONTRIBUTING.md](CONTRIBUTING.md).
