Skip to main content

🛡️ SecretShield

Your secrets shouldn't end up in your terminal, your logs, or your commit history.

PyPI version Python versions PyPI downloads License: MIT

Install · Demo · Try it · Full usage guide →


You've done this. Everyone has: a stray print() left in from debugging, a log line that dumps a config dict, a hardcoded key that slips past review. SecretShield catches it before it leaves your machine — redacted from your terminal output automatically, scanned out of your codebase on demand, and blocked from your commits if it gets that far.

Demo

SecretShield Demo

▶ Watch the full demo on YouTube

Install

pip install secretshield

Try it

import secretshield

api_key = "sk-example1234567890abcdefFAKEKEY"
print("API key:", api_key)
API key: ********
⚠ secretshield: Potential secret detected and redacted.

No config, no code changes — the moment you import it, stdout, stderr, and logging are protected.

Scan a project:

secretshield scan .

Set a project up in one step — config file, Git hook, CI workflow:

secretshield init

(Every command also works via the shorter ss alias.)

What it does

🖥️ Runtime protection import secretshield redacts secrets from stdout, stderr, and logging automatically
🔍 Static scanning secretshield scan . finds hardcoded secrets across Python, JS/TS, HTML, YAML, .env, and more
🔧 Auto-Fix scan . --fix moves a hardcoded Python or JS/TS secret into .env and rewrites the code — only when it's unambiguous
🪝 Git hook install-hook blocks a commit before a secret reaches your history
⚙️ GitHub Actions github-action generates a workflow that scans every push and PR

No required dependencies, no telemetry, no network calls. Everything runs locally, in your own process.

For the full command reference, configuration options, and exactly how Auto-Fix decides what's safe to rewrite, see the usage guide.

Limitations

Runtime protection covers this Python process's stdout/stderr/ logging — not screenshots, the clipboard, or other applications. Auto-Fix only rewrites Python and JS/TS, and only unambiguous assignments; anything less certain is reported, not modified. Treat SecretShield as a strong safety net, not a replacement for proper secret management. Details in the usage guide.

Contributing

Issues and PRs welcome. Add tests for new detection patterns or behavior changes, use only fake credentials in tests/examples, and run pytest before opening a PR.

☕ Get me a coffee

If you find this project useful, consider supporting its development through GitHub Sponsors.

License

MIT — see LICENSE.

Release files for secretshield 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for secretshield 0.6.1
File Size Uploaded
secretshield-0.6.1.tar.gz 55.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for secretshield 0.6.1
File Interpreter ABI Platform
secretshield-0.6.1-py3-none-any.whl Python 3 none any Details

Total release size: 98.5 kB

Release files / secretshield-0.6.1.tar.gz

Download URL secretshield-0.6.1.tar.gz
Size 55.9 kB
Tags Source
SHA-256 checksum
How to use checksums
58bd3a59dc8f9cbe2cdbe77a1e06ee07c253e1121afbd66d0ad6a66fafc05501
BLAKE2b-256 checksum
How to use checksums
a3aa1e5482534f4cc9ff91e386f5f17a279a0a8e909a0cc5b1ce5ca3a9de021a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.2

Release files / secretshield-0.6.1-py3-none-any.whl

Download URL secretshield-0.6.1-py3-none-any.whl
Size 42.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
00ac315e8cc98ae1018a94b77208bfd1bea347138546d8d87102c5dfb957f7e2
BLAKE2b-256 checksum
How to use checksums
008e4b4cb43e614ba6447051860e02f33e7c690c4bf3911e3baaa60d8f9a19dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.2

Release history Release notifications | RSS feed

0.7.0

2 release files

This release

0.6.1 This release

2 release files

0.6.0

2 release files

0.5.2

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page