https://github.com/zanebrackley/reportgenerator
https://github.com/zanebrackley/reportgenerator
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zanebrackley/reportgenerator
- Owner: ZaneBrackley
- Created: 2025-04-07T01:42:15.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2025-04-07T06:15:48.000Z (2 months ago)
- Last Synced: 2025-04-07T07:25:14.327Z (2 months ago)
- Language: Python
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Automated Monthly Cybersecurity Report Generator
## Overview
This project automates the extraction of data from PDF reports generated by Datto, processes and stores the extracted data in a local SQL database, and generates a structured, user-editable report in Microsoft Word (.docx) format. The report provides a comprehensive analysis of security, device performance, backup status, patch compliance, and recommendations for clients.
## Features
- Extraction of text and structured data from uploaded PDFs using `pdfplumber` and `Camelot`.
- Storage of extracted data in a local SQLite database (can be configured for other databases).
- Generation of a structured, user-editable report in .docx format.
- Customizable report template with branding elements.
- Logging and monitoring for security and integrity.
## Requirements
- Python 3.8+
- Libraries:
- Flask
- SQLAlchemy
- pdfplumber
- camelot-py
- opencv-python
- python-docx
- SQL Database (SQLite by default, configurable in `config.py`)
## Installation
1. Clone the repository:
```
git clone https://github.com/ZaneBrackley/ReportGenerator.git
cd ReportGenerator
```
2. Setup the Virtual Environment and install the required Python libraries:
`For Mac-OS and Linux`
```
source ./setup.sh
```
`For Windows`
```
call setup.bat
```
3. Configure the database connection in `config.py` (if necessary).
## Usage
1. Run the Flask application to upload and process the reports:
```
python app/app.py
```
1. Upload the PDF's that were downloaded from Datto RMM.
2. The application will extract data from the PDFs, store it in the SQLite database, and generate a structured report in the root folder.
3. The application will also reset the database and clear existing records whenever new files are uploaded.
## Support
For any questions or support, please contact [email protected]