Skip to main content

Generate HTML security reports from Trivy and pip-audit JSON

Project description

sec-report-kit

Generate HTML vulnerability reports from Trivy and pip-audit JSON with a CLI and MCP server.

Install

pip install -e .

With MCP support:

pip install -e .[mcp]

CLI Usage

Both commands are available:

  • srk
  • sec-report-kit

Render Trivy JSON:

srk render trivy --input security_reports/trivy-image-report-v1.0.21.json --output security_reports/report-trivy.html --target shankonduru/cpkc-poc:v1.0.21

Render pip-audit JSON:

srk render pip-audit --input pip-audit.json --output security_reports/report-pip-audit.html --target requirements.txt

Helper Scripts (bat/sh)

Cross-platform helper scripts are available in scripts/.

Install this package and pip-audit:

# Linux/macOS
bash scripts/install_tools.sh

# Windows
scripts\install_tools.bat

Run pip-audit and write JSON output:

# Linux/macOS (optional args: <report_dir> <requirements_file>)
bash scripts/run_pip_audit.sh
bash scripts/run_pip_audit.sh reports requirements.txt

# Windows (optional args: <report_dir> <requirements_file>)
scripts\run_pip_audit.bat
scripts\run_pip_audit.bat reports requirements.txt

Convert pip-audit JSON report to HTML:

# Linux/macOS (optional args: <report_dir> <target_name>)
bash scripts/render_pip_audit_html.sh
bash scripts/render_pip_audit_html.sh reports requirements.txt

# Windows (optional args: <report_dir> <target_name>)
scripts\render_pip_audit_html.bat
scripts\render_pip_audit_html.bat reports requirements.txt

By default, JSON is written to reports/pip-audit.json and HTML to reports/pip-audit-report.html.

MCP Server

Run MCP server over stdio:

srk mcp serve --transport stdio

Available MCP Tools

Tool Description
summarize_json Summarize vulnerabilities by severity from a JSON file
render_report_from_json Parse JSON and render an HTML report to disk
validate_input Validate that a JSON file is parseable and return finding count

All tools accept source_type ("trivy" or "pip-audit") and input_path (absolute path to JSON file).


VS Code (GitHub Copilot Agent / MCP extension)

Add to your VS Code settings.json (or .vscode/mcp.json in the workspace):

{
  "mcp": {
    "servers": {
      "sec-report-kit": {
        "type": "stdio",
        "command": "srk",
        "args": ["mcp", "serve", "--transport", "stdio"]
      }
    }
  }
}

Note: If srk is not on the system PATH, replace "command" with the full path to the executable, e.g. "C:/Users/you/.venv/Scripts/srk.exe".


Claude Desktop

Edit %APPDATA%\Claude\claude_desktop_config.json (Windows) or ~/Library/Application Support/Claude/claude_desktop_config.json (macOS):

{
  "mcpServers": {
    "sec-report-kit": {
      "command": "srk",
      "args": ["mcp", "serve", "--transport", "stdio"]
    }
  }
}

Cursor

Open Cursor Settings → MCP and add a new server entry:

{
  "sec-report-kit": {
    "command": "srk",
    "args": ["mcp", "serve", "--transport", "stdio"]
  }
}

Or add it to .cursor/mcp.json in your project root:

{
  "mcpServers": {
    "sec-report-kit": {
      "command": "srk",
      "args": ["mcp", "serve", "--transport", "stdio"]
    }
  }
}

Windsurf (Codeium)

Edit ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "sec-report-kit": {
      "command": "srk",
      "args": ["mcp", "serve", "--transport", "stdio"]
    }
  }
}

Using a virtual environment

If the package is installed in a .venv, use the full path to avoid PATH issues:

Windows:

{
  "command": "C:/MyProjects/sec-report-kit/.venv/Scripts/srk.exe",
  "args": ["mcp", "serve", "--transport", "stdio"]
}

macOS / Linux:

{
  "command": "/home/user/sec-report-kit/.venv/bin/srk",
  "args": ["mcp", "serve", "--transport", "stdio"]
}

Package Publish

Build:

python -m build

Upload to TestPyPI:

python -m twine upload --repository testpypi dist/*

Upload to PyPI:

python -m twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sec_report_kit-0.1.6.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sec_report_kit-0.1.6-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file sec_report_kit-0.1.6.tar.gz.

File metadata

  • Download URL: sec_report_kit-0.1.6.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sec_report_kit-0.1.6.tar.gz
Algorithm Hash digest
SHA256 c56d3a87a63f8005fa778bb0f18ba2c2a8da3d3c2b5ce539effc7bf62e27db57
MD5 3236c31259edd60c542302dcfcf4c79a
BLAKE2b-256 b3d181c7b37ac9eaf51823ccd7b4957726165de1cf0f3195e01ed396d815e479

See more details on using hashes here.

Provenance

The following attestation bundles were made for sec_report_kit-0.1.6.tar.gz:

Publisher: publish-pypi.yml on ShanKonduru/sec-report-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sec_report_kit-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: sec_report_kit-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sec_report_kit-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 97ab86c63584bdb9361863ca8a91e1520ad67f3527d485bb3f957cc83e25165d
MD5 bcf789d9e2c530d7700389d85942222a
BLAKE2b-256 f271ce6c0bc51f737ee6f952dfddcc712ce0ef414fcbd5c2abde51b8d4f96826

See more details on using hashes here.

Provenance

The following attestation bundles were made for sec_report_kit-0.1.6-py3-none-any.whl:

Publisher: publish-pypi.yml on ShanKonduru/sec-report-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page