diff --git a/README.md b/README.md new file mode 100644 index 0000000..bbdb205 --- /dev/null +++ b/README.md @@ -0,0 +1,270 @@ +#
V-Aguatech – Automatic Technical Report Generator
+ +--- + +##
Overview
+ +V-Aguatech is a desktop application developed in Python for the automatic generation of technical inspection reports in Microsoft Word format. + +The platform was designed to streamline field inspection workflows by allowing investigators and technicians to: + +- Fill structured inspection data +- Attach photographs +- Document applied inspection techniques +- Register participants during inspections +- Automatically generate professional DOCX reports from templates + +The application uses a dynamic Word template system with automatic placeholder replacement and image insertion. + +--- + +#
Main Features
+ +## Automatic DOCX Report Generation + +- Dynamic placeholder replacement +- Automatic generation of timestamped reports +- Structured technical documentation + +--- + +## Image Processing + +- Single image insertion +- Multiple image insertion +- Automatic image conversion to PNG +- Automatic image resizing inside reports + +--- + +## Technical Inspection Management + +The system allows the user to document: + +- Visual inspection techniques +- Humidity measurements +- Thermal camera inspections +- Endoscopic camera analysis +- Pressure testing +- Color dye testing +- Obstruction testing + +Each technique supports: +- Description field +- Multiple attached photographs + +--- + +## Presence Registration + +The application supports recording: + +- Insured individuals +- Injured parties +- Other participants + +Including: +- Names +- Statements +- Presence tracking during inspections + +--- + +#
Technologies Used
+ +| Technology | Purpose | +|:---:|:---:| +| Python | Main programming language | +| Tkinter | Desktop graphical interface | +| python-docx | Microsoft Word manipulation | +| Pillow (PIL) | Image processing | +| io / tempfile | Temporary image stream handling | + +--- + +#
Project Structure
+ +```txt +. +├── vaguatechrelatorios_VF1.py +├── Corpus.docx +├── README.md +``` + +--- + +#
Requirements
+ +## Python Version + +```txt +Python 3.10+ +``` + +--- + +#
Required Libraries
+ +Install dependencies: + +```bash +pip install python-docx pillow +``` + +--- + +#
Running the Application
+ +Execute: + +```bash +python vaguatechrelatorios_VF1.py +``` + +--- + +#
Required Template
+ +The application requires the following template file in the same directory: + +```txt +Corpus.docx +``` + +This template contains placeholders used for automatic replacement. + +--- + +#
Supported Placeholders
+ +## Text Placeholders + +| Placeholder | Description | +|:---:|:---:| +| `{{nproc}}` | Process number | +| `{{segurado}}` | Insured person | +| `{{comp}}` | Insurance company | +| `{{terceiro}}` | Third party | +| `{{data}}` | Inspection date | +| `{{local da visita}}` | Inspection location | +| `{{descriçãoimovel}}` | Property description | +| `{{anoconstr}}` | Construction year | +| `{{descricao}}` | Inspection description | +| `{{area}}` | Area inspected | + +--- + +## Image Placeholders + +| Placeholder | Description | +|:---:|:---:| +| `{{foto1}}` | Main inspection image | +| `{{foto2}}` | Multiple inspection images | + +--- + +## Technical Sections + +| Placeholder | Description | +|:---:|:---:| +| `{{tecnicasutilizadas}}` | Inspection techniques | +| `{{iniciopesquisa}}` | Initial investigation methods | +| `{{metodosutilizados}}` | Combined methods list | + +--- + +#
Generated Output
+ +Reports are automatically generated with timestamp naming: + +```txt +YYYY-MM-DD_HH-MM-SS.docx +``` + +Example: + +```txt +2026-05-21_15-30-00.docx +``` + +--- + +#
User Interface
+ +The application provides: + +- Structured inspection form +- Dynamic participant management +- Multi-image selection +- Technique management windows +- Automatic validation popups +- Error handling interface + +--- + +#
Error Handling
+ +The application automatically handles: + +- Missing templates +- Invalid image formats +- Missing placeholders +- DOCX generation failures + +--- + +#
Main Functionalities
+ +## Automatic Image Conversion + +All images are automatically converted to PNG streams before insertion into Word documents. + +--- + +## Dynamic Report Sections + +The system dynamically builds: + +- Participant summaries +- Technical method sections +- Inspection conclusions +- Multi-image layouts + +--- + +#
Intended Use Cases
+ +- Insurance inspections +- Technical damage assessments +- Building inspections +- Water damage investigations +- Field technical reports +- Evidence documentation + +--- + +#
Future Improvements
+ +- PDF export +- Database integration +- Digital signatures +- Multi-user system +- Cloud synchronization +- OCR integration +- AI-assisted report writing + +--- + +#
Disclaimer
+ +This software is intended for technical documentation and inspection support purposes. + +Users remain responsible for validating generated reports before official submission. + +--- + +#
Author
+ +José Garcia +Data Scientist +PhD Researcher – Digitalization Engineering \ No newline at end of file