Features

This chapter covers the core features and capabilities of Security Report Generator.

Features

• Self-contained HTML — single-file output with embedded CSS, works in any browser offline
• Executive summary — overall risk score with finding count by severity
• Severity ratings — findings categorized as critical, high, medium, low, or informational
• Remediation steps — actionable fix for each finding
• Demo mode — generate a sample report instantly to see the output format
• Configurable branding — custom title, subtitle, and accent color
• Summary mode — condensed overview without full finding details
• Statistics dashboard — visual breakdown of findings by severity and category

Requirements

• Python 3.10+
• No external dependencies (stdlib only)

Quick Start

Follow this guide to get Security Report Generator up and running in your environment.

Quick Start

# Generate a report from scan results
python src/security_report_generator.py --input scan_results.json

# Custom title and output path
python src/security_report_generator.py --input scan_results.json --title "Q1 Audit" --output report.html

# Summary-only report
python src/security_report_generator.py --input scan_results.json --format summary

# Generate a demo report
python src/security_report_generator.py --demo

Output

Produces a self-contained HTML file with a dark-themed design. The report includes:

• Risk score header with severity breakdown
• Executive summary for non-technical stakeholders
• Detailed findings table with severity, description, and remediation
• Statistics section with finding counts by category