✨ Pentest Report Generator

pentest-report-generator

This tool allows you to generate a professional-looking Penetration Testing Report from a simple Markdown file, applying a clean HTML template, and exporting to both HTML and PDF formats.

---

📜 Philosophy

This tool was created following the KISS (Keep It Simple, Stupid) principle.

• Minimal setup.
• Minimal dependencies.
• Maximum portability.
• Designed for security consultants and pentesters who want a fast, clean way to generate reports without complicated setups or online tools.

---

📦 Project Structure

• report.md — Write your report content here (Markdown format).
• template.html — HTML template for styling the report.
• generate_report.py — Script to generate the report.
• requirements.txt — Python packages required (for uv pip).
• img/logo.png — Logo displayed on the title page.
• run.sh — Script to setup environment and generate report.

---

⚙️ Setup

First, install uv if you don't have it:

pipx install uv

(uv is a fast tool for managing virtual environments and Python packages.)

---

🚀 How to Generate the Report

1. Clone or unzip this project.

2. Navigate into the project folder:

cd pentest-report-generator

3. Run the generation script:

./run.sh

This will:

• Create a virtual environment (.venv/)
• Install necessary Python packages
• Generate your report in both HTML and PDF format

---

📂 Output Files

After running the script, two files will be created in the project folder:

• final_report.html — Web version of your report
• final_report.pdf — Printable PDF version of your report

---

📝 Notes

• Add your findings and text inside report.md.

• If you want to add images (e.g., screenshots), place them in the img/ folder and reference them in your Markdown like this:

  ![Alt text](img/your_image.png)

• Images automatically resize to fit the PDF page correctly.

---

📚 Suggested Usage

You can treat the pentest-report-generator folder as a temporary working folder for each pentest engagement:

• Copy the entire folder for each new engagement.
• Use it to store notes, screenshots, drafts, evidence, etc.
• Edit report.md as you progress through the assessment.
• Generate the final report easily with one command.
• Securely wipe the folder after the engagement is completed and the report is delivered.

✅ This encourages structured work, clear documentation, and easy cleanup.

---

🧡 License

Feel free to use, modify, and adapt for personal or professional purposes.

---