sec-report-kit 0.3.2__tar.gz → 0.3.4__tar.gz

{sec_report_kit-0.3.2 → sec_report_kit-0.3.4}/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.2 → sec_report_kit-0.3.4}/PKG-INFO

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

{sec_report_kit-0.3.2 → sec_report_kit-0.3.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sec-report-kit"
-version = "0.3.2"
+version = "0.3.4"
 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.4/scripts/mcp_add_workspace_filesystem.bat

@@ -0,0 +1,43 @@
+@echo off
+setlocal EnableExtensions EnableDelayedExpansion
+
+set "PROFILE=%~1"
+if "%PROFILE%"=="" set "PROFILE=shan_s_mcp_hub"
+
+set "TARGET_PATH=%~2"
+if "%TARGET_PATH%"=="" set "TARGET_PATH=%~dp0.."
+
+for %%I in ("%TARGET_PATH%") do set "ABS_PATH=%%~fI"
+
+where docker >nul 2>nul
+if errorlevel 1 (
+	echo ERROR: docker CLI was not found in PATH.
+	exit /b 1
+)
+
+echo Using profile: %PROFILE%
+echo Allowing path: %ABS_PATH%
+
+set "SERVER_REF=catalog://mcp/docker-mcp-catalog/filesystem"
+docker mcp profile server add "%PROFILE%" --server "%SERVER_REF%" >nul 2>nul
+if errorlevel 1 (
+	echo Filesystem server may already exist in profile. Continuing...
+) else (
+	echo Added filesystem server to profile.
+)
+
+set "ESCAPED_PATH=%ABS_PATH:\=\\%"
+docker mcp profile config "%PROFILE%" --set "filesystem.paths=[%ESCAPED_PATH%]"
+if errorlevel 1 (
+	echo ERROR: failed to set filesystem.paths.
+	exit /b 1
+)
+
+echo.
+echo Done. Current filesystem.paths value:
+docker mcp profile config "%PROFILE%" --get filesystem.paths
+if errorlevel 1 exit /b 1
+
+echo.
+echo Example:
+echo   %~nx0 shan_s_mcp_hub C:\MyProjects\sec-report-kit

sec_report_kit-0.3.4/scripts/mcp_add_workspace_filesystem.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+PROFILE="${1:-shan_s_mcp_hub}"
+TARGET_PATH="${2:-$(dirname "$0")/..}"
+
+if command -v cygpath >/dev/null 2>&1; then
+  # Git Bash/MSYS path -> Windows path for Docker Desktop on Windows.
+  ABS_PATH="$(cygpath -w "$(cd "$TARGET_PATH" && pwd)")"
+else
+  ABS_PATH="$(cd "$TARGET_PATH" && pwd)"
+fi
+
+if ! command -v docker >/dev/null 2>&1; then
+  echo "ERROR: docker CLI was not found in PATH."
+  exit 1
+fi
+
+echo "Using profile: ${PROFILE}"
+echo "Allowing path: ${ABS_PATH}"
+
+SERVER_REF="catalog://mcp/docker-mcp-catalog/filesystem"
+if docker mcp profile server add "${PROFILE}" --server "${SERVER_REF}" >/dev/null 2>&1; then
+  echo "Added filesystem server to profile."
+else
+  echo "Filesystem server may already exist in profile. Continuing..."
+fi
+
+ESCAPED_PATH="${ABS_PATH//\\/\\\\}"
+docker mcp profile config "${PROFILE}" --set "filesystem.paths=[${ESCAPED_PATH}]"
+
+echo
+echo "Done. Current filesystem.paths value:"
+docker mcp profile config "${PROFILE}" --get filesystem.paths
+
+echo
+echo "Example:"
+echo "  ./scripts/mcp_add_workspace_filesystem.sh shan_s_mcp_hub /c/MyProjects/sec-report-kit"

sec_report_kit-0.3.4/scripts/mcp_add_workspace_filesystem_help.md

@@ -0,0 +1,109 @@
+# MCP Add Workspace Filesystem Scripts — Usage Guide
+
+This document explains how to use the provided scripts to add any local folder (such as this repository) to your Docker Desktop MCP Toolkit profile as a filesystem server.
+
+---
+
+## Scripts Overview
+
+- **mcp_add_workspace_filesystem.bat** — For Windows (cmd/PowerShell)
+- **mcp_add_workspace_filesystem.sh** — For Linux, macOS, or Git Bash (Windows)
+
+Both scripts automate:
+- Adding the MCP filesystem server to your chosen profile (if not already present)
+- Setting the allowed path(s) for the server to the folder you specify
+
+---
+
+## Prerequisites
+
+- **Docker Desktop** must be installed and running
+- **Docker MCP Toolkit** must be available in your PATH (the `docker mcp` command should work)
+- You should have an existing MCP profile (e.g., `shan_s_mcp_hub`)
+
+---
+
+## Usage
+
+### Windows (cmd/PowerShell)
+
+```bat
+scripts\mcp_add_workspace_filesystem.bat [profile] [folder]
+```
+- `profile` (optional): MCP profile name (default: `shan_s_mcp_hub`)
+- `folder` (optional): Path to the folder to allow (default: parent of scripts folder)
+
+**Example:**
+```bat
+scripts\mcp_add_workspace_filesystem.bat shan_s_mcp_hub C:\MyProjects\sec-report-kit
+```
+
+### Linux/macOS/Git Bash
+
+```sh
+./scripts/mcp_add_workspace_filesystem.sh [profile] [folder]
+```
+- `profile` (optional): MCP profile name (default: `shan_s_mcp_hub`)
+- `folder` (optional): Path to the folder to allow (default: parent of scripts folder)
+
+**Example:**
+```sh
+./scripts/mcp_add_workspace_filesystem.sh shan_s_mcp_hub /c/MyProjects/sec-report-kit
+```
+
+---
+
+## What the Scripts Do
+
+1. **Add the filesystem server** to your MCP profile (if not already present)
+2. **Set the allowed path** for the server to the folder you specify
+3. **Print the current allowed paths** for verification
+
+---
+
+## How to Use the MCP Server in Docker
+
+1. **Start Docker Desktop**
+2. **Start the MCP Gateway** with your profile:
+   ```
+   docker mcp gateway start --profile shan_s_mcp_hub
+   ```
+3. **Use MCP-compatible tools/clients** to interact with your workspace via the filesystem server (e.g., list files, read/write, etc.)
+   - Example: List files
+     ```
+     docker mcp client call filesystem.list_directory --profile shan_s_mcp_hub --args path="C:\\MyProjects\\sec-report-kit"
+     ```
+4. **Stop the gateway** when done:
+   ```
+   docker mcp gateway stop
+   ```
+
+---
+
+## Troubleshooting
+
+- Ensure Docker Desktop is running and healthy
+- Ensure `docker mcp` commands work in your terminal
+- If you see permission errors, check that the folder path is correct and accessible
+- You can run the script multiple times for different folders or profiles
+
+---
+
+## Notes
+
+- The scripts are idempotent: running them again with the same arguments is safe
+- You can add multiple folders by editing the profile config or running the script for each folder
+- For advanced usage, see `docker mcp profile --help` and `docker mcp profile server add --help`
+
+---
+
+## Committing the Scripts
+
+Be sure to commit both scripts and this help document to your repository:
+- `scripts/mcp_add_workspace_filesystem.bat`
+- `scripts/mcp_add_workspace_filesystem.sh`
+- `scripts/mcp_add_workspace_filesystem_help.md`
+
+---
+
+For further help, see the official Docker MCP Toolkit documentation or ask your AI assistant.

{sec_report_kit-0.3.2 → sec_report_kit-0.3.4}/src/sec_report_kit/__init__.py

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

{sec_report_kit-0.3.2 → sec_report_kit-0.3.4}/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.2 → sec_report_kit-0.3.4}/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