sensitive-data-detector 1.1.0

A package to detect sensitive information in code and files

Sensitive Data Detector 🔍

A Python package that helps detect sensitive information in files and code. Protect your codebase from accidental exposure of API keys, passwords, tokens, and other sensitive data.

🚀 Features

• 🔑 Detects API keys and tokens
• 📧 Identifies email addresses
• 🔐 Finds sensitive patterns in code
• ⚙️ Configurable detection patterns
• 📁 Works with any text-based file
• 🛡️ Pre-commit hook support
• 🧑‍💻 Now fully object-oriented for easier extension and testing!

📦 Installation

pip install sensitive_data_detector

🎯 Quick Start

from sensitive_data_detector import SensitiveChecker

checker = SensitiveChecker()  # Optionally pass a custom config path
result = checker.has_sensitive_info("path/to/your/file.txt")
if result:
    True #(sensitive info found in the file)
else:
    False #(no sensitive info found)

🔍 What It Detects

The package detects various types of sensitive information, including:

• API Keys and Tokens
• Email Addresses
• Private Keys
• Access Tokens
• Passwords
• And more configurable patterns

🛠️ Development Setup

# Clone the repository
git clone https://github.com/akashdv25/sensitive_info_detector.git
cd sensitive_info_detector

# Create and activate virtual environment (optional)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run pre-commit hooks
pre-commit run --all-files

🔧 Configuration

The package uses a config.json file that defines patterns for sensitive information detection. You can customize these patterns for your specific needs.

Default patterns include:

{
    "sensitive_info": {
        "api_keys": "(?i)((api[_-]key|apikey|api_secret|api[_-]token|auth[_-]token|access[_-]token)['\"]?\\s*[:=]\\s*['\"]([\\w\\-._]+)['\"])",
        "emails": "\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Z|a-z]{2,}\\b"
    }
}

🐍 Python Version Support

• Python 3.9
• Python 3.10
• Python 3.11

🛠️ Built With

• Python - Programming Language
• Black - Code Formatting
• isort - Import Sorting
• Flake8 - Code Linting
• pytest - Testing Framework
• pre-commit - Git Hooks Framework
• Now with full type checking using mypy

🆕 Changelog

v1.1.0 (new)

• Refactored core modules to use object-oriented programming (OOP) principles.
• Added SensitiveChecker, PatternLoader, FileReader, and ContentAnalyzer classes.
• Improved type annotations and mypy compatibility.
• Enhanced code maintainability and extensibility.

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests (pytest)
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

🔗 Project Links

• PyPI: sensitive-data-detector
• GitHub Repository
• Bug Tracker

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

📫 Contact

Akash Anandani

• Email

---

Made with ❤️ by Akash Anandani