Metadata-Version: 2.4
Name: dd-parser-cleaner
Version: 0.2.0
Summary: A private, local LLM-powered data dictionary parser and entity mapper with automated cleaning.
Project-URL: Homepage, https://github.com/user/dd-parser-cleaner
Project-URL: Repository, https://github.com/user/dd-parser-cleaner
Author-email: Rajiv <rajiv@example.com>
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27.0
Requires-Dist: ollama>=0.2.0
Requires-Dist: pandas>=2.2.0
Requires-Dist: pydantic>=2.6.0
Requires-Dist: pypdf>=4.1.0
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: requests>=2.34.2
Requires-Dist: rich>=13.7.0
Requires-Dist: tabulate>=0.10.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# dd-parser-cleaner

A private, local LLM-powered data dictionary parser, entity mapper, and case-preserving data transformation pipeline. This package crawls raw dataset structures, classifies attributes through local inference, and executes deterministic data cleaning routines while protecting case variations and file formats.

## 🚀 Quick Start

### 1. Installation

This repository uses `uv` for environment management and dependency tracking.

```bash
# Clone the repository and sync the local virtual environment
cd dd_parser_cleaner
uv sync

# Install package command entry points in editable mode
uv pip install -e .
```

### 2. Run the Pipeline CLI

```bash
# Step 1: Ingest layout and classify data dictionary entities
classify-entities --workspace . --config config.yaml

# Step 2: Validate signatures and execute geographic scrubbing routines
clean-dataset --workspace . --config config.yaml
```

### 3. Run Automated Tests (`pytest`)

All integration tests run inside an isolated folder context to ensure production directories are never contaminated.

```bash
uv run pytest -v tests/
```

---

## 📑 Core Documentation Index

For deep-dive architectural specifications, path coordinator details, and pipeline handshake rules, please consult the full documentation suite:

* 👉 **[USER_GUIDE.md](USER_GUIDE.md)**: Exhaustive manual detailing hardened engineering constraints, file-routing abstraction schemas, data transformation algorithms, and structural testing profiles.
