ggshield_sdk_secret_scanning_text_with_gitguardian_api.py

1from pygitguardian import GGClient
2from ggshield.core.config import Config
3from ggshield.core.scan import ScanContext, ScanMode
4from ggshield.verticals.secret import SecretScanner
5
6# Initialize the config and client
7config = Config()
8client = GGClient(api_key=config.api_key, endpoint=config.api_url)
9
10# Define the text to scan
11text_to_scan = "My secret API key is: sgp_1234567890abcdef"
12
13# Initialize the scanner
14scanner = SecretScanner(
15    client=client,
16    cache=None,
17    scan_context=ScanContext(
18        scan_mode=ScanMode.CLI,
19        command_id="sdk_scan",
20    ),
21)
22
23# Perform the scan
24results = scanner.scan_text(text_to_scan)
25
26# Access findings
27if results.findings:
28    for finding in results.findings:
29        print(f"Found secret: {finding.match} of type {finding.detector_name}")
30else:
31    print("No secrets found.")