checsum
checsum scans your project for potential secrets before code is pushed to Git.
It detects common patterns such as usernames, passwords, API tokens, private keys,
and authorization headers, then generates a full HTML report with:
- file name
- exact location (line and column)
- finding type
- matched value (or preview)
Install
pip install checsum
Usage
Scan the current directory and create an HTML report:
checsum --path . --output checsum-report.html
Fail CI if possible secrets are found:
checsum --path . --fail-on-findings
Ignore additional globs:
checsum --path . --ignore "*.pem" --ignore "docs/*"
Example Output
The report includes:
- scan timestamp
- root path scanned
- total files and findings
- grouped breakdown by finding type
- detailed table of each hit with path, line, column, severity, and extracted snippet
Use as a pre-push safety check
Create .git/hooks/pre-push:
#!/usr/bin/env bash
set -euo pipefail
checsum --path . --output checsum-report.html --fail-on-findings
Then make it executable:
chmod +x .git/hooks/pre-push
Notes
checsum is a heuristic scanner. It can produce false positives and should be used
as an early warning signal, not a replacement for secret management best practices.
Metadata
Release files for checsum 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| checsum-0.1.4.tar.gz | 10.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| checsum-0.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 20.5 kB
Release files / checsum-0.1.4.tar.gz
| Download URL | checsum-0.1.4.tar.gz |
|---|---|
| Size | 10.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
167928228af47569cae153d5c34e2df06e6b935dee6f8170edcc533cb32f74c1
|
|
BLAKE2b-256 checksum How to use checksums |
74c31bdcb5a76b8130756a37afc18f65fbcd640e78b267197562ed222b01b887
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.0
|
Release files / checsum-0.1.4-py3-none-any.whl
| Download URL | checsum-0.1.4-py3-none-any.whl |
|---|---|
| Size | 10.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
375427083c1c9c59a848982c25da65677e337382f8ab6f3a12005678ffe833f5
|
|
BLAKE2b-256 checksum How to use checksums |
a817c9904c0f83d52f95f44c4847dd66d9afdfaf34c272d0df967b31a5331f27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.0
|