Getting Started

Getting Started

This page is the shortest path to running PDF TO ESX AGENT.

Option 1: Use a Packaged Windows Build

If the project has a packaged Windows release asset on the Releases page, that is the easiest non-developer path.

Use it like this:

1. Download the packaged release archive.
2. Unzip the full app folder to a normal writable location.
3. Launch PDF-TO-ESX-Agent.exe.
4. Add one or more estimate PDFs.
5. Choose an output folder and convert.

Important:

• ship or extract the whole app folder, not only the .exe
• there is no installer yet
• the packaged build is currently a PyInstaller onedir app because that is the more reliable option for this stack

Option 2: Run From Source

Requirements:

• Windows
• Python 3.12 or later available through py -3
• Tkinter support in the Python install

Setup:

py -3 -m venv .venv
.\.venv\Scripts\python.exe -m pip install --upgrade pip
.\.venv\Scripts\python.exe -m pip install -r requirements.txt

Run:

.\scripts\Run-App.ps1

Alternative:

.\.venv\Scripts\python.exe .\run_app.py

First Use

When the app opens:

1. Drag estimate PDFs into the drop zone or use the file picker.
2. Confirm the selected-file list looks right.
3. Choose an output folder.
4. Click Convert.
5. Review the status area, warnings, and generated output paths.

Successful runs write:

• *.esx
• *.esx.xml
• *.canonical.json

Where To Read Next

• How PDF to ESX Works
• Example Workflow
• Repository README
• Windows EXE build details
• Developer docs start page