Adicionar README.md

2026-05-22 09:58:38 +00:00
parent 7ea91dee62
commit 066c14d00a
1 changed files with 270 additions and 0 deletions
@@ -0,0 +1,270 @@
+# <div align="center">V-Aguatech – Automatic Technical Report Generator</div>
+
+---
+
+## <div align="center">Overview</div>
+
+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.
+
+---
+
+# <div align="center">Main Features</div>
+
+## 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
+
+---
+
+# <div align="center">Technologies Used</div>
+
+| 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 |
+
+---
+
+# <div align="center">Project Structure</div>
+
+```txt
+.
+├── vaguatechrelatorios_VF1.py
+├── Corpus.docx
+├── README.md
+```
+
+---
+
+# <div align="center">Requirements</div>
+
+## Python Version
+
+```txt
+Python 3.10+
+```
+
+---
+
+# <div align="center">Required Libraries</div>
+
+Install dependencies:
+
+```bash
+pip install python-docx pillow
+```
+
+---
+
+# <div align="center">Running the Application</div>
+
+Execute:
+
+```bash
+python vaguatechrelatorios_VF1.py
+```
+
+---
+
+# <div align="center">Required Template</div>
+
+The application requires the following template file in the same directory:
+
+```txt
+Corpus.docx
+```
+
+This template contains placeholders used for automatic replacement.
+
+---
+
+# <div align="center">Supported Placeholders</div>
+
+## 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 |
+
+---
+
+# <div align="center">Generated Output</div>
+
+Reports are automatically generated with timestamp naming:
+
+```txt
+YYYY-MM-DD_HH-MM-SS.docx
+```
+
+Example:
+
+```txt
+2026-05-21_15-30-00.docx
+```
+
+---
+
+# <div align="center">User Interface</div>
+
+The application provides:
+
+- Structured inspection form
+- Dynamic participant management
+- Multi-image selection
+- Technique management windows
+- Automatic validation popups
+- Error handling interface
+
+---
+
+# <div align="center">Error Handling</div>
+
+The application automatically handles:
+
+- Missing templates
+- Invalid image formats
+- Missing placeholders
+- DOCX generation failures
+
+---
+
+# <div align="center">Main Functionalities</div>
+
+## 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
+
+---
+
+# <div align="center">Intended Use Cases</div>
+
+- Insurance inspections
+- Technical damage assessments
+- Building inspections
+- Water damage investigations
+- Field technical reports
+- Evidence documentation
+
+---
+
+# <div align="center">Future Improvements</div>
+
+- PDF export
+- Database integration
+- Digital signatures
+- Multi-user system
+- Cloud synchronization
+- OCR integration
+- AI-assisted report writing
+
+---
+
+# <div align="center">Disclaimer</div>
+
+This software is intended for technical documentation and inspection support purposes.
+
+Users remain responsible for validating generated reports before official submission.
+
+---
+
+# <div align="center">Author</div>
+
+José Garcia
+Data Scientist
+PhD Researcher – Digitalization Engineering