py-gitguardian - GitGuardian API Client
API client library for the GitGuardian API.
The GitGuardian API puts at your fingertips the power to detect more than 200 types of secrets in any text content, as well as other potential security vulnerabilities.
py-gitguardian can be used to create integrations to scan various data sources, from your workstation's filesystem to your favorite chat application.
You can check API details here with all the response codes and expected structures on each method.
Requirements
Python 3.8+
[!WARNING] Python 3.8 support is deprecated and will be removed in a future release. On Python 3.8,
marshmallow3.x is used; Python 3.9+ usesmarshmallow4.x.
Projects using py-gitguardian
- GitGuardian Shield - Scan for secrets in your CI and pre-commit.
Getting started
You can obtain API keys for API usage on your dashboard.
pip
pip3 install --upgrade pygitguardian
pipenv
pipenv install pygitguardian
pdm
pdm add pygitguardian
poetry
poetry add pygitguardian
Examples
Check examples/ for full examples on how to use py-gitguardian.
Scanning text content
# please don't hardcode your gg_api_key in source code :)
API_KEY = os.getenv("GITGUARDIAN_API_KEY")
DOCUMENT = """
import urllib.request
url = 'http://jen_barber:correcthorsebatterystaple@cake.gitguardian.com/isreal.json'
response = urllib.request.urlopen(url)
consume(response.read())"
"""
client = GGClient(api_key=API_KEY)
# Check the health of the API and the API key used.
if client.health_check().success:
try:
scan_result = client.content_scan(DOCUMENT)
except Exception as exc:
# Handle exceptions such as schema validation
traceback.print_exc(2, file=sys.stderr)
print(str(exc))
print(scan_result)
else:
print("Invalid API Key")
Scanning multiple files
API_KEY = os.getenv("GITGUARDIAN_API_KEY")
client = GGClient(api_key=API_KEY)
# Create a list of dictionaries for scanning
file_paths = (pathlib.Path(name) for name in glob.iglob("**/*", recursive=True))
to_scan = [
{"filename": path.name, "document": path.read_text(errors="replace")}
for path in file_paths
]
scan = client.multi_content_scan(to_scan)
Transform results to dict or JSON
Any model in py-gitguardian can be turned to a JSON string or a dictionary using
the to_dict and to_json methods.
from pygitguardian.models import Detail
detail = Detail("Invalid API Key.")
print(detail.to_dict())
print(detail.to_json())
Dependencies
Py-gitguardian depends on these excellent libraries:
requests- HTTP clientmarshmallow- Request (de)serialization and input validation
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pygitguardian-1.33.0.tar.gz.
File metadata
- Download URL: pygitguardian-1.33.0.tar.gz
- Upload date:
- Size: 59.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fbf352d64131edd61ba413549c10d23b2e4f4dbd64786357e8d82775e7c8db96
|
|
| MD5 |
dfb5e0b738a47dad170f0d8ea0c25e48
|
|
| BLAKE2b-256 |
bae07564c10e60df597972782db7f408dbe818c9bdcc73cfb4baf6ec74c4fdf7
|
File details
Details for the file pygitguardian-1.33.0-py3-none-any.whl.
File metadata
- Download URL: pygitguardian-1.33.0-py3-none-any.whl
- Upload date:
- Size: 24.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f0dfe586b76927eb746c0d3f1e1ec20f7dc8841b3a1350e784dfb4b318718f88
|
|
| MD5 |
44c2c2b67cf3f6dd6885111b209262d2
|
|
| BLAKE2b-256 |
70ec93cb70f9d199f52cf2593c6ee414e334848ac9bba4b87c5f01ac61821d26
|
