sec-report-kit 0.2.4__tar.gz → 0.2.5__tar.gz

{sec_report_kit-0.2.4 → sec_report_kit-0.2.5}/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project are documented in this file.
 
+## 0.2.5 - 2026-05-17
+
+### Added
+- New CLI command: `srk render consolidated` to build a single HTML report from all supported scanner reports in an input folder.
+- New helper scripts for consolidated rendering:
+  - `scripts/render_consolidated_html.sh`
+  - `scripts/render_consolidated_html.bat`
+
+### Changed
+- `src/sec_report_kit/generate_consolidated_security_report.py` now acts as a wrapper that accepts `--input`, `--output`, and `--target`, and delegates to the consolidated CLI renderer.
+
+### Fixed
+- Unified package version metadata by aligning `src/sec_report_kit/__init__.py` with the project version.
+
 ## 0.2.4 - 2026-05-14
 
 ### Added

{sec_report_kit-0.2.4 → sec_report_kit-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sec-report-kit
-Version: 0.2.4
+Version: 0.2.5
 Summary: Generate HTML security reports from Trivy, pip-audit, Safety, Bandit, and Gitleaks JSON
 Author: Ravi Konduru
 License: MIT
@@ -82,6 +82,14 @@ Render Safety JSON:
 srk render safety --input security_reports/safety.json --output security_reports/report-safety.html --target requirements.txt
 ```
 
+Render a consolidated HTML report from all supported scanner files in a directory:
+
+```bash
+srk render consolidated --input security_reports --output security_reports --target sec-report-kit
+```
+
+This command writes `consolidated-security-report.html` to the output folder.
+
 ## Helper Scripts (bat/sh)
 
 Cross-platform helper scripts are available in `scripts/`.
@@ -232,6 +240,18 @@ scripts\render_trivy_html.bat
 scripts\render_trivy_html.bat security_reports my-image
 ```
 
+Convert all supported scanner reports in a folder to one consolidated HTML report:
+
+```bash
+# Linux/macOS (optional args: <report_dir> <target_name>)
+bash scripts/render_consolidated_html.sh
+bash scripts/render_consolidated_html.sh security_reports sec-report-kit
+
+# Windows (optional args: <report_dir> <target_name>)
+scripts\render_consolidated_html.bat
+scripts\render_consolidated_html.bat security_reports sec-report-kit
+```
+
 Convert sample Bandit JSON report to HTML:
 
 ```bash

{sec_report_kit-0.2.4 → sec_report_kit-0.2.5}/README.md

@@ -55,6 +55,14 @@ Render Safety JSON:
 srk render safety --input security_reports/safety.json --output security_reports/report-safety.html --target requirements.txt
 ```
 
+Render a consolidated HTML report from all supported scanner files in a directory:
+
+```bash
+srk render consolidated --input security_reports --output security_reports --target sec-report-kit
+```
+
+This command writes `consolidated-security-report.html` to the output folder.
+
 ## Helper Scripts (bat/sh)
 
 Cross-platform helper scripts are available in `scripts/`.
@@ -205,6 +213,18 @@ scripts\render_trivy_html.bat
 scripts\render_trivy_html.bat security_reports my-image
 ```
 
+Convert all supported scanner reports in a folder to one consolidated HTML report:
+
+```bash
+# Linux/macOS (optional args: <report_dir> <target_name>)
+bash scripts/render_consolidated_html.sh
+bash scripts/render_consolidated_html.sh security_reports sec-report-kit
+
+# Windows (optional args: <report_dir> <target_name>)
+scripts\render_consolidated_html.bat
+scripts\render_consolidated_html.bat security_reports sec-report-kit
+```
+
 Convert sample Bandit JSON report to HTML:
 
 ```bash

{sec_report_kit-0.2.4 → sec_report_kit-0.2.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sec-report-kit"
-version = "0.2.4"
+version = "0.2.5"
 description = "Generate HTML security reports from Trivy, pip-audit, Safety, Bandit, and Gitleaks JSON"
 readme = "README.md"
 requires-python = ">=3.10"

sec_report_kit-0.2.5/scripts/render_consolidated_html.bat

@@ -0,0 +1,25 @@
+@echo off
+setlocal
+
+set "PYTHON_BIN=python"
+if exist "%~dp0..\.venv\Scripts\python.exe" set "PYTHON_BIN=%~dp0..\.venv\Scripts\python.exe"
+
+set "REPORT_DIR=%~1"
+if "%REPORT_DIR%"=="" set "REPORT_DIR=security_reports"
+
+set "TARGET_NAME=%~2"
+if "%TARGET_NAME%"=="" for %%I in ("%~dp0..") do set "TARGET_NAME=%%~nxI"
+
+if not exist "%REPORT_DIR%" (
+  echo Missing input directory: %REPORT_DIR%
+  exit /b 1
+)
+
+set "OUT_HTML=%REPORT_DIR%\consolidated-security-report.html"
+
+"%PYTHON_BIN%" -m sec_report_kit render consolidated --input "%REPORT_DIR%" --output "%REPORT_DIR%" --target "%TARGET_NAME%"
+if errorlevel 1 exit /b 1
+
+echo HTML report written to %OUT_HTML%
+for %%I in ("%OUT_HTML%") do set "OUT_HTML_ABS=%%~fI"
+start "" "%OUT_HTML_ABS%"

sec_report_kit-0.2.5/scripts/render_consolidated_html.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+PYTHON_BIN="${PYTHON_BIN:-python}"
+if [[ -x "$(dirname "$0")/../.venv/bin/python" ]]; then
+  PYTHON_BIN="$(dirname "$0")/../.venv/bin/python"
+fi
+
+REPORT_DIR="${1:-security_reports}"
+ROOT_NAME="$(basename "$(cd "$(dirname "$0")/.." && pwd)")"
+TARGET_NAME="${2:-${ROOT_NAME}}"
+OUT_HTML="${REPORT_DIR}/consolidated-security-report.html"
+
+open_html() {
+  if command -v xdg-open >/dev/null 2>&1; then
+    xdg-open "$1" >/dev/null 2>&1 &
+    return 0
+  fi
+  if command -v open >/dev/null 2>&1; then
+    open "$1" >/dev/null 2>&1 &
+    return 0
+  fi
+  echo "HTML generated but no supported browser opener was found. Open manually: $1"
+}
+
+if [[ ! -d "${REPORT_DIR}" ]]; then
+  echo "Missing input directory: ${REPORT_DIR}"
+  exit 1
+fi
+
+"${PYTHON_BIN}" -m sec_report_kit render consolidated --input "${REPORT_DIR}" --output "${REPORT_DIR}" --target "${TARGET_NAME}"
+
+echo "HTML report written to ${OUT_HTML}"
+open_html "${OUT_HTML}"

{sec_report_kit-0.2.4 → sec_report_kit-0.2.5}/src/sec_report_kit/__init__.py

@@ -1,4 +1,4 @@
 """sec_report_kit package."""
 
 __all__ = ["__version__"]
-__version__ = "0.2.2"
+__version__ = "0.2.5"

{sec_report_kit-0.2.4 → sec_report_kit-0.2.5}/src/sec_report_kit/cli.py

@@ -44,35 +44,38 @@ def _load_json(path: Path) -> Any:
         return items
 
 
+def _parse_findings(payload: Any, parser: str):
+    if parser == "trivy":
+        return parse_trivy_json(payload)
+    if parser == "pip-audit":
+        return parse_pip_audit_json(payload)
+    if parser == "safety":
+        return parse_safety_json(payload)
+    if parser == "bandit":
+        return parse_bandit_json(payload)
+    if parser == "gitleaks":
+        return parse_gitleaks_json(payload)
+    if parser == "semgrep":
+        return parse_semgrep_json(payload)
+    if parser == "codeql":
+        return parse_codeql_json(payload)
+    if parser == "osv-scanner":
+        return parse_osv_scanner_json(payload)
+    if parser == "checkov":
+        return parse_checkov_json(payload)
+    if parser == "tfsec":
+        return parse_tfsec_json(payload)
+    if parser == "trufflehog":
+        return parse_trufflehog_json(payload)
+    raise typer.BadParameter(f"Unsupported parser: {parser}")
+
+
 def _write_report(source_label: str, target_ref: str, input_path: Path, output_path: Path, parser: str) -> None:
     payload = _load_json(input_path)
     if parser == "auto":
         parser = detect_source_type(payload)
         typer.echo(f"[INFO] Detected source type: {parser}")
-    if parser == "trivy":
-        findings = parse_trivy_json(payload)
-    elif parser == "pip-audit":
-        findings = parse_pip_audit_json(payload)
-    elif parser == "safety":
-        findings = parse_safety_json(payload)
-    elif parser == "bandit":
-        findings = parse_bandit_json(payload)
-    elif parser == "gitleaks":
-        findings = parse_gitleaks_json(payload)
-    elif parser == "semgrep":
-        findings = parse_semgrep_json(payload)
-    elif parser == "codeql":
-        findings = parse_codeql_json(payload)
-    elif parser == "osv-scanner":
-        findings = parse_osv_scanner_json(payload)
-    elif parser == "checkov":
-        findings = parse_checkov_json(payload)
-    elif parser == "tfsec":
-        findings = parse_tfsec_json(payload)
-    elif parser == "trufflehog":
-        findings = parse_trufflehog_json(payload)
-    else:
-        raise typer.BadParameter(f"Unsupported parser: {parser}")
+    findings = _parse_findings(payload, parser)
 
     findings = sort_findings(findings)
     counts = count_by_severity(findings)
@@ -205,6 +208,75 @@ def render_trufflehog(
     _write_report("trufflehog", target, input, output, parser="trufflehog")
 
 
+@render_app.command("consolidated")
+def render_consolidated(
+    input: Path = typer.Option(
+        ...,
+        "--input",
+        exists=True,
+        dir_okay=True,
+        file_okay=False,
+        readable=True,
+        help="Folder containing scanner JSON/SARIF report files",
+    ),
+    output: Path = typer.Option(
+        ...,
+        "--output",
+        dir_okay=True,
+        file_okay=False,
+        help="Output folder where consolidated HTML will be written",
+    ),
+    target: str = typer.Option("consolidated-scan", "--target", help="Consolidated target label"),
+) -> None:
+    """Render a consolidated HTML report from all supported report files in a directory."""
+    candidates = sorted(
+        [
+            path
+            for path in input.iterdir()
+            if path.is_file()
+            and (
+                path.suffix.lower() in {".json", ".sarif", ".ndjson", ".jsonl"}
+                or path.name.lower().endswith(".sarif.json")
+            )
+        ]
+    )
+
+    all_findings = []
+    included_files = 0
+    skipped_files = 0
+    for report_file in candidates:
+        try:
+            payload = _load_json(report_file)
+            parser = detect_source_type(payload)
+            findings = _parse_findings(payload, parser)
+            all_findings.extend(findings)
+            included_files += 1
+            typer.echo(f"[INFO] Included {report_file.name} as {parser} ({len(findings)} findings)")
+        except Exception as exc:
+            skipped_files += 1
+            typer.echo(f"[WARN] Skipping {report_file.name}: {exc}")
+
+    all_findings = sort_findings(all_findings)
+    counts = count_by_severity(all_findings)
+    report_html = render_html_report(
+        target_ref=target,
+        source_label="consolidated",
+        findings=all_findings,
+        counts=counts,
+    )
+
+    output.mkdir(parents=True, exist_ok=True)
+    output_file = output / "consolidated-security-report.html"
+    output_file.write_text(report_html, encoding="utf-8")
+
+    typer.echo(f"[OK] Report generated: {output_file}")
+    typer.echo(f"[INFO] Input directory: {input}")
+    typer.echo(f"[INFO] Files included: {included_files}")
+    typer.echo(f"[INFO] Files skipped: {skipped_files}")
+    typer.echo(f"[INFO] Total findings: {len(all_findings)}")
+    typer.echo(f"[INFO] Severity counts: {counts}")
+
+
 @mcp_app.command("serve")
 def serve_mcp(
     transport: str = typer.Option("stdio", "--transport", help="MCP transport (currently stdio)")

sec_report_kit-0.2.5/src/sec_report_kit/generate_consolidated_security_report.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+import argparse
+from pathlib import Path
+
+from sec_report_kit.cli import render_consolidated
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(
+        description="Generate a consolidated HTML security report from scanner JSON/SARIF files"
+    )
+    parser.add_argument("--input", required=True, help="Input folder containing report files")
+    parser.add_argument("--output", required=True, help="Output folder for generated HTML")
+    parser.add_argument("--target", default="consolidated-scan", help="Target label used in HTML report")
+    args = parser.parse_args()
+
+    render_consolidated(
+        input=Path(args.input),
+        output=Path(args.output),
+        target=args.target,
+    )
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

{sec_report_kit-0.2.4 → sec_report_kit-0.2.5}/tests/test_cli.py

@@ -403,3 +403,96 @@ def test_render_tfsec_command(tmp_path):
     assert result.exit_code == 0
     assert output_file.exists()
     assert "AWS001" in output_file.read_text()
+
+
+def test_render_consolidated_command_from_directory(tmp_path):
+    reports_dir = tmp_path / "security_reports"
+    reports_dir.mkdir()
+
+    trivy_file = reports_dir / "trivy.json"
+    trivy_file.write_text(json.dumps(TRIVY_PAYLOAD))
+
+    bandit_file = reports_dir / "bandit.json"
+    bandit_file.write_text(json.dumps(BANDIT_PAYLOAD))
+
+    # Non-report content should be skipped safely.
+    ignored_file = reports_dir / "notes.json"
+    ignored_file.write_text(json.dumps({"hello": "world"}))
+
+    output_dir = tmp_path / "out"
+
+    result = runner.invoke(
+        app,
+        [
+            "render",
+            "consolidated",
+            "--input",
+            str(reports_dir),
+            "--output",
+            str(output_dir),
+            "--target",
+            "repo-root",
+        ],
+    )
+
+    output_file = output_dir / "consolidated-security-report.html"
+    assert result.exit_code == 0
+    assert output_file.exists()
+    html = output_file.read_text()
+    assert "CVE-2024-0001" in html
+    assert "B101" in html
+    assert "Source: <strong>consolidated</strong>" in html
+
+
+def test_render_consolidated_command_empty_or_unsupported_directory(tmp_path):
+    reports_dir = tmp_path / "security_reports"
+    reports_dir.mkdir()
+    (reports_dir / "unsupported.json").write_text(json.dumps({"invalid": True}))
+
+    output_dir = tmp_path / "out"
+    result = runner.invoke(
+        app,
+        ["render", "consolidated", "--input", str(reports_dir), "--output", str(output_dir)],
+    )
+
+    output_file = output_dir / "consolidated-security-report.html"
+    assert result.exit_code == 0
+    assert output_file.exists()
+    html = output_file.read_text()
+    assert "No vulnerabilities found." in html
+
+
+def test_generate_consolidated_wrapper_invokes_cli(monkeypatch, tmp_path):
+    input_dir = tmp_path / "reports"
+    output_dir = tmp_path / "out"
+    input_dir.mkdir()
+
+    monkeypatch.setattr(
+        "sys.argv",
+        [
+            "generate_consolidated_security_report.py",
+            "--input",
+            str(input_dir),
+            "--output",
+            str(output_dir),
+            "--target",
+            "repo-root",
+        ],
+    )
+
+    with patch("sec_report_kit.generate_consolidated_security_report.render_consolidated") as mock_render:
+        from sec_report_kit.generate_consolidated_security_report import main as wrapper_main
+
+        exit_code = wrapper_main()
+
+    assert exit_code == 0
+    mock_render.assert_called_once_with(
+        input=input_dir,
+        output=output_dir,
+        target="repo-root",
+    )
+
+
+def test_consolidated_helper_scripts_exist():
+    assert Path("scripts/render_consolidated_html.bat").exists()
+    assert Path("scripts/render_consolidated_html.sh").exists()