Skip to main content

An educational CLI tool to prevent accidental sensitive data exposure.

Project description

safe-push 🛡️

An educational, beginner-friendly Python CLI tool that teaches you about accidental sensitive data exposure while helping you keep your repositories clean.

🌟 Why safe-push?

Accidentally pushing a .env file or a hardcoded API key to GitHub is a rite of passage for many developers—but it's also a major security risk! safe-push helps you identify these risks before you push, explaining why certain files shouldn't be shared.

Perfect for "vibe coders" and beginners who want to stay safe while learning.

🚀 Features

🆓 Free Tier (Always)

  • Scan Current Directory: Detects common mistakes like .env files, __pycache__, and venv folders.
  • Basic Secret Detection: Finds generic API keys and tokens.
  • Educational Insights: Explains the danger of each finding so you learn as you go.
  • No Data Leaves Your Machine: Your code stays local. Always.

💎 Premium Features

  • Advanced Secret Scanning: Deep detection for AWS, Stripe, OpenAI, Firebase, and more.
  • Auto .gitignore Generator: Quickly create a recommended .gitignore for your Python projects.
  • Pre-commit Hook Template: Automatically scan your code every time you try to git commit.
  • Verbose Mode: See exactly what's happening under the hood.

🛠️ Installation

pip install safe-push

📖 How to Use

Simply run the tool in your project's root directory:

safe-push

Options

  • safe-push --verbose: Show a detailed breakdown of the scan.
  • safe-push --unlock: Learn how to unlock premium features.
  • safe-push --generate-gitignore: (Premium) Create a recommended .gitignore.
  • safe-push --install-hook: (Premium) Install a Git pre-commit hook.

🔓 Unlocking Premium (The Solana Way)

We use a simple, decentralized verification system. No accounts, no credit cards.

  1. Donate at least 0.005 SOL (~$2) to the recipient wallet shown when you run safe-push --unlock.
  2. Enter your wallet address and the Transaction ID (TXID).
  3. The CLI verifies the transaction directly on the Solana blockchain and unlocks your features locally!

🔒 Security & Privacy

  • Local Only: This tool scans only your local directory.
  • Privacy First: No data, code, or telemetry is ever sent to any server.
  • Transparency: The only network call made is to a public Solana RPC endpoint for donation verification.

📜 License

MIT License. Feel free to use, learn, and share!


Stay safe and keep coding! 🚀

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

safe_push-0.1.0.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

safe_push-0.1.0-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file safe_push-0.1.0.tar.gz.

File metadata

  • Download URL: safe_push-0.1.0.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for safe_push-0.1.0.tar.gz
Algorithm Hash digest
SHA256 217e45e9e44f2cc681a9cff41b513799e9e0d3c598a17cfb6be33d1af7e2c44c
MD5 ff2a88ea768421d0dea7077766452153
BLAKE2b-256 16280ccbefb980afb91faf1cf56b8159c24218b4d858f83d5f783c9c4955feae

See more details on using hashes here.

File details

Details for the file safe_push-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: safe_push-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for safe_push-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4c4b79125c206c81ed5279a3bfebc53643c6e0ebeac666a678a0ff2235d0cf5
MD5 18c6a95252cafa668f0280fce13f81e2
BLAKE2b-256 b130d63fcad0bff9e5a6c9c87ac6ef1c1def58d6d049332c6f1ae17f0d6fec4f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page