# Flatten JSON for easier spreadsheet importcd hpra-xml-parser

.\HPRAParser.exe --flatten```

Or download the ZIP from GitHub and extract it locally.

# Process files from custom locations

.\HPRAParser.exe --input "C:\MyData\XML" --output "C:\MyData\JSON"### 2. Prepare a Python environment

Use a recent Python 3.9+ interpreter. Optionally create a virtual environment:

# Disable quality reports```bash

.\HPRAParser.exe --no-reportpython -m venv .venv

```.venv\Scripts\activate  # Windows PowerShell

# source .venv/bin/activate  # macOS / Linux

## Installation (Technical Users)```



### Requirements### 3. Add HPRA XML files

Place the XML files you want to convert into:

- Python 3.9 or higher```

- openpyxl (for Excel quality reports)<repo-root>/data/input

git clone https://github.com/snbyrnes/PharmaForm.gitUse the trigger script to convert everything in `data/input` to JSON files in `data/output`:

cd PharmaForm```bash

python -m pip install -e .python trigger/run_parser.py

Create a standalone `HPRAParser.exe` that ships with its own Python runtime and ready-to-use `data` folders:

## Command-Line Options

1. On a Windows build machine with Python 3.9+ installed, open PowerShell, change into the repository, and run:

```   ```powershell

usage: hpra-xml-parser [-h] [--flatten] [--input INPUT] [--output OUTPUT]   powershell -ExecutionPolicy Bypass -File trigger/build_bundle.ps1

                       [--no-report] [--report-format {excel,text,both}]   ```

                       [files ...]   The script installs or upgrades PyInstaller automatically. Add `-Python "C:/Path/To/python.exe"` if you need a specific interpreter, or `-SkipInstall` to reuse an existing PyInstaller install.

2. The script generates `dist/HPRAParser.exe` and assembles a shareable `dist/HPRAParser-bundle/` directory containing the executable plus ready-to-use `data/input` and `data/output` folders.

Options:3. Zip the `HPRAParser-bundle` directory and distribute it to end users.

  files                 Specific XML files to process (optional)4. End users unzip the bundle, drop XML files into `data/input`, and run `HPRAParser.exe` (pass flags such as `--flatten` the same way) — no Python installation needed.

  --flatten             Output flattened JSON for BI tools

  --input INPUT         Custom input directory## Advanced Usage

  --output OUTPUT       Custom output directory- Process specific files only:

  --no-report           Disable quality summary report  ```bash

  --report-format       Report format: excel, text, or both (default: excel)  python trigger/run_parser.py latestHumanlist.xml another.xml

```  ```

- Override input/output directories:

## Advanced Usage for Analytics  ```bash

  python trigger/run_parser.py --input "C:/data/hpra" --output "C:/data/hpra-json"

### Flattened JSON for Business Intelligence  ```

- Generate quality summary reports (default: Excel format):

The `--flatten` option produces table-friendly JSON optimized for tools like Power BI, Tableau, and Excel:  ```bash

  python trigger/run_parser.py --flatten

```bash  # Creates: data/output/quality_report_YYYYMMDD_HHMMSS.xlsx

python -m hpra_parser.cli --flatten  ```

```- Disable quality reports:

  ```bash

Output structure:  python trigger/run_parser.py --no-report

- Nested objects become dot-notation keys (e.g., `Product.Name`)  ```

- Arrays are indexed (e.g., `Ingredient[0].Name`)- Generate text format reports:

- Suitable for direct import into spreadsheets and databases  ```bash

  python trigger/run_parser.py --report-format text

### Batch Processing Multiple Files  ```

- The bundled executable accepts the same flags:

```bash  ```powershell

# Process all XML files in a directory  .\HPRAParser.exe --flatten --input "D:/hpra/input" --output "D:/hpra/output"

python -m hpra_parser.cli --input "/path/to/xml/files" --flatten  ```

- Install the package locally (optional):

# Process specific files only  ```bash

python -m hpra_parser.cli file1.xml file2.xml --flatten  python -m pip install -e .

```  python -m hpra_parser.cli --flatten

Get Data → Excel → Select quality_report_*.xlsx│  └─ quality_report.py      # Quality summary report generation

Load all sheets for complete dashboard├─ dist/

```│  ├─ HPRAParser-bundle/     # Prebuilt executable and data folders (zero-dependency)

│  └─ HPRAParser.exe         # Raw PyInstaller output (copied into the bundle)

**Python Automation:**├─ trigger/

```python│  └─ run_parser.py          # Desktop-friendly entrypoint

from hpra_parser.quality_report import BatchMetrics, generate_excel_report├─ data/

from pathlib import Path│  ├─ input/                 # Drop XML files here

│  └─ output/                # JSON output and quality reports appear here

# Programmatic access to reporting├─ QUALITY_REPORT_GUIDE.md   # Detailed quality report documentation

metrics = BatchMetrics()└─ README.md

# ... add results ...```

generate_excel_report(metrics, Path("report.xlsx"))

```## Notes



**Scheduled Processing:**1. This tool is not associated with, or validated by the HPRA.

```powershell2. Please contribute by using the issues function to report bugs and suggest enhancements.

# Windows Task Scheduler script   

cd C:\PharmaForm
python -m hpra_parser.cli --flatten --report-format both
# Archive reports as needed

PharmaForm/
├── hpra_parser/              # Core library
│   ├── cli.py                # Command-line interface
│   ├── converter.py          # XML to JSON conversion
│   └── quality_report.py     # Report generation
├── data/
│   ├── input/                # XML files (source)
│   └── output/               # JSON files and reports
├── trigger/
│   ├── run_parser.py         # Convenience script
│   └── build_bundle.ps1      # Executable builder
└── dist/
    └── HPRAParser-bundle/    # Distributable package