sec-report-kit 0.3.1__tar.gz → 0.3.3__tar.gz

{sec_report_kit-0.3.1 → sec_report_kit-0.3.3}/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project are documented in this file.
 
+## 0.3.3 - 2026-05-21
+
+### Added
+- Added `sec_report_kit` console script alias alongside `srk` and `sec-report-kit`.
+
+### Changed
+- CLI startup now suppresses the ASCII banner for `--help` and `--version` so these flags output only command help/version details.
+
+### Tests
+- Added regression tests for top-level `--help` and `--version` banner behavior.
+
 ## 0.2.9 - 2026-05-18
 
 ### Changed

{sec_report_kit-0.3.1 → sec_report_kit-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sec-report-kit
-Version: 0.3.1
+Version: 0.3.3
 Summary: Generate HTML security reports from Trivy, pip-audit, Safety, Bandit, and Gitleaks JSON
 Author: Ravi Konduru
 License: MIT

{sec_report_kit-0.3.1 → sec_report_kit-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sec-report-kit"
-version = "0.3.1"
+version = "0.3.3"
 description = "Generate HTML security reports from Trivy, pip-audit, Safety, Bandit, and Gitleaks JSON"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -39,6 +39,7 @@ dev = [
 
 [project.scripts]
 srk = "sec_report_kit.cli:main"
+sec_report_kit = "sec_report_kit.cli:main"
 "sec-report-kit" = "sec_report_kit.cli:main"
 
 [tool.hatch.build.targets.wheel]

sec_report_kit-0.3.3/scripts/run_all_security_scans.bat

@@ -0,0 +1,129 @@
+@echo off
+REM Master script to run all security scans one by one
+REM Each scan launches in a new command window
+REM Opens the consolidated HTML report at the end
+
+setlocal enabledelayedexpansion
+
+cd /d "%~dp0\.."
+
+echo.
+echo ========================================
+echo Running All Security Scans
+echo ========================================
+echo.
+
+set REPORT_DIR=security_reports
+if not exist "%REPORT_DIR%" mkdir "%REPORT_DIR%"
+
+REM Use absolute path for report directory
+for %%I in ("%~dp0..") do set "PROJECT_ROOT=%%~fI"
+set "REPORT_DIR=%PROJECT_ROOT%\security_reports"
+if not exist "%REPORT_DIR%" mkdir "%REPORT_DIR%"
+
+REM Run Bandit
+echo Starting: Bandit scan...
+start "Bandit Scan" /wait cmd /c "cd /d %CD%\scripts && call run_bandit.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Bandit scan
+echo Rendering Bandit report...
+call scripts\render_bandit_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Checkov
+echo Starting: Checkov scan...
+start "Checkov Scan" /wait cmd /c "cd /d %CD%\scripts && call run_checkov.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Checkov scan
+echo Rendering Checkov report...
+call scripts\render_checkov_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run CodeQL
+echo Starting: CodeQL scan...
+start "CodeQL Scan" /wait cmd /c "cd /d %CD%\scripts && call run_codeql.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: CodeQL scan
+echo Rendering CodeQL report...
+call scripts\render_codeql_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Gitleaks
+echo Starting: Gitleaks scan...
+start "Gitleaks Scan" /wait cmd /c "cd /d %CD%\scripts && call run_gitleaks.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Gitleaks scan
+echo Rendering Gitleaks report...
+call scripts\render_gitleaks_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run OSV Scanner
+echo Starting: OSV Scanner scan...
+start "OSV Scanner Scan" /wait cmd /c "cd /d %CD%\scripts && call run_osv_scanner.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: OSV Scanner scan
+echo Rendering OSV Scanner report...
+call scripts\render_osv_scanner_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Pip Audit
+echo Starting: Pip Audit scan...
+start "Pip Audit Scan" /wait cmd /c "cd /d %CD%\scripts && call run_pip_audit.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Pip Audit scan
+echo Rendering Pip Audit report...
+call scripts\render_pip_audit_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Safety
+echo Starting: Safety scan...
+start "Safety Scan" /wait cmd /c "cd /d %CD%\scripts && call run_safety.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Safety scan
+echo Rendering Safety report...
+call scripts\render_safety_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Semgrep
+echo Starting: Semgrep scan...
+start "Semgrep Scan" /wait cmd /c "cd /d %CD%\scripts && call run_semgrep.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Semgrep scan
+echo Rendering Semgrep report...
+call scripts\render_semgrep_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Tfsec
+echo Starting: Tfsec scan...
+start "Tfsec Scan" /wait cmd /c "cd /d %CD%\scripts && call run_tfsec.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Tfsec scan
+echo Rendering Tfsec report...
+call scripts\render_tfsec_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Trivy
+echo Starting: Trivy scan...
+start "Trivy Scan" /wait cmd /c "cd /d %CD%\scripts && call run_trivy.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Trivy scan
+echo Rendering Trivy report...
+call scripts\render_trivy_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Run Trufflehog
+echo Starting: Trufflehog scan...
+start "Trufflehog Scan" /wait cmd /c "cd /d %CD%\scripts && call run_trufflehog.bat "%REPORT_DIR%" "%PROJECT_ROOT%""
+echo Completed: Trufflehog scan
+echo Rendering Trufflehog report...
+call scripts\render_trufflehog_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo.
+
+REM Generate consolidated report
+echo.
+echo ========================================
+echo Generating Consolidated Report
+echo ========================================
+echo.
+echo Rendering: Consolidated Security Report
+call scripts\render_consolidated_html.bat "%REPORT_DIR%" "%PROJECT_ROOT%"
+echo Completed: Consolidated Report
+echo.
+
+echo.
+echo ========================================
+echo All Security Scans Complete
+echo ========================================
+echo.
+
+endlocal

sec_report_kit-0.3.3/scripts/run_all_security_scans.sh

@@ -0,0 +1,104 @@
+#!/bin/bash
+
+# Master script to run all security scans one by one
+# Each scan launches in a new terminal window (for GUI systems)
+# Opens the consolidated HTML report at the end
+
+set -e  # Exit on error
+
+SCRIPTS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(dirname "$SCRIPTS_DIR")"
+REPORT_DIR="$PROJECT_ROOT/security_reports"
+
+cd "$PROJECT_ROOT"
+mkdir -p "$REPORT_DIR"
+
+echo ""
+echo "========================================"
+echo "Running All Security Scans"
+echo "========================================"
+echo ""
+
+# Function to run a scan and render its report
+run_scan_and_render() {
+    local scan_name=$1
+    local scan_script="run_${scan_name}.sh"
+    local render_script="render_${scan_name}_html.sh"
+    
+    if [ ! -f "$SCRIPTS_DIR/$scan_script" ]; then
+        echo "WARNING: $scan_script not found, skipping..."
+        return
+    fi
+    
+    echo "Starting: $scan_name scan..."
+        bash "$SCRIPTS_DIR/$scan_script" "$REPORT_DIR/" "$PROJECT_ROOT" || echo "WARNING: $scan_script failed"
+    echo "Completed: $scan_name scan"
+    
+    if [ -f "$SCRIPTS_DIR/$render_script" ]; then
+        echo "Rendering: $scan_name report..."
+            bash "$SCRIPTS_DIR/$render_script" "$REPORT_DIR/" "$PROJECT_ROOT" || echo "WARNING: $render_script failed"
+        echo "Completed: $scan_name report"
+    fi
+    echo ""
+}
+
+# Run all security scans
+run_scan_and_render "bandit"
+run_scan_and_render "checkov"
+run_scan_and_render "codeql"
+run_scan_and_render "gitleaks"
+run_scan_and_render "osv_scanner"
+run_scan_and_render "pip_audit"
+run_scan_and_render "safety"
+run_scan_and_render "semgrep"
+run_scan_and_render "tfsec"
+run_scan_and_render "trivy"
+run_scan_and_render "trufflehog"
+
+# Generate consolidated report
+echo ""
+echo "========================================"
+echo "Generating Consolidated Report"
+echo "========================================"
+echo ""
+
+if [ -f "$SCRIPTS_DIR/render_consolidated_html.sh" ]; then
+    echo "Rendering: Consolidated Security Report"
+    bash "$SCRIPTS_DIR/render_consolidated_html.sh" "$REPORT_DIR" "$PROJECT_ROOT" || echo "WARNING: Consolidated report generation failed"
+    echo "Completed: Consolidated Report"
+    echo ""
+fi
+
+# Open the consolidated HTML report
+CONSOLIDATED_REPORT="$REPORT_DIR/consolidated-security-report.html"
+
+if [ -f "$CONSOLIDATED_REPORT" ]; then
+    echo ""
+    echo "========================================"
+    echo "Opening Consolidated Security Report"
+    echo "========================================"
+    echo ""
+    
+    # Try different methods to open the report based on the OS
+    if command -v xdg-open &> /dev/null; then
+        # Linux
+        xdg-open "$CONSOLIDATED_REPORT"
+    elif command -v open &> /dev/null; then
+        # macOS
+        open "$CONSOLIDATED_REPORT"
+    else
+        echo "Could not automatically open report. Please open manually:"
+        echo "$CONSOLIDATED_REPORT"
+    fi
+    
+    echo "Report opened"
+else
+    echo ""
+    echo "WARNING: Consolidated report not found at: $CONSOLIDATED_REPORT"
+fi
+
+echo ""
+echo "========================================"
+echo "All Security Scans Complete"
+echo "========================================"
+echo ""

{sec_report_kit-0.3.1 → sec_report_kit-0.3.3}/src/sec_report_kit/__init__.py

@@ -1,4 +1,4 @@
 """sec_report_kit package."""
 
 __all__ = ["__version__"]
-__version__ = "0.2.9"
+__version__ = "0.3.3"

{sec_report_kit-0.3.1 → sec_report_kit-0.3.3}/src/sec_report_kit/cli.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import datetime as dt
 import json
+import sys
 from pathlib import Path
 from typing import Any
 
@@ -467,7 +468,8 @@ ASCII_BANNER = """
 
 
 def main() -> None:
-    typer.echo(ASCII_BANNER)
+    if not any(flag in sys.argv[1:] for flag in ("--help", "-h", "--version")):
+        typer.echo(ASCII_BANNER)
     app()
 
 

{sec_report_kit-0.3.1 → sec_report_kit-0.3.3}/tests/test_cli.py

@@ -305,6 +305,36 @@ def test_main_calls_app(monkeypatch):
     assert exc.value.code == 0
 
 
+def test_main_help_does_not_print_banner(monkeypatch, capsys):
+    import pytest
+
+    monkeypatch.setattr("sys.argv", ["srk", "--help"])
+    from sec_report_kit.cli import main
+
+    with pytest.raises(SystemExit) as exc:
+        main()
+
+    captured = capsys.readouterr()
+    assert exc.value.code == 0
+    assert "____  _____" not in captured.out
+
+
+def test_main_version_does_not_print_banner(monkeypatch, capsys):
+    import pytest
+    from sec_report_kit import __version__
+
+    monkeypatch.setattr("sys.argv", ["srk", "--version"])
+    from sec_report_kit.cli import main
+
+    with pytest.raises(SystemExit) as exc:
+        main()
+
+    captured = capsys.readouterr()
+    assert exc.value.code == 0
+    assert f"sec-report-kit {__version__}" in captured.out
+    assert "____  _____" not in captured.out
+
+
 # Cover cli.py line 195: except ValueError as exc: (in _parse_modified_since)
 def test_parse_modified_since_invalid_value():
     from sec_report_kit.cli import _parse_modified_since