scanipy-cli 0.1.0

A powerful CLI tool to scan GitHub repositories for security patterns and vulnerabilities

📡 Scanipy

A powerful command-line tool to scan open source code-bases on GitHub for security patterns and vulnerabilities. Scanipy searches GitHub repositories for specific code patterns and optionally runs Semgrep or CodeQL analysis on discovered code.

🎯 Features

• Smart Code Search: Search GitHub for specific code patterns across millions of repositories
• Tiered Star Search: Prioritize popular, well-maintained repositories by searching in star tiers
• Keyword Filtering: Filter results by keywords found in file contents
• Semgrep Integration: Automatically clone and scan repositories with Semgrep
• CodeQL Integration: Run CodeQL analysis for deep semantic security scanning
• Custom Rules: Use built-in security rules or provide your own

⚡ Quick Start

# Clone and setup
git clone https://github.com/papadoxie/scanipy.git
cd scanipy
python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

# Set GitHub token
export GITHUB_TOKEN="your_token_here"

# Search for code patterns
python scanipy.py --query "extractall" --language python

# Run Semgrep analysis
python scanipy.py --query "extractall" --language python --run-semgrep

# Run CodeQL analysis
python scanipy.py --query "extractall" --language python --run-codeql

📚 Documentation

Full documentation is available in the docs/ directory:

Document	Description
Installation	Setup instructions and prerequisites
Usage Guide	Basic and advanced usage
Semgrep Integration	Running Semgrep security analysis
CodeQL Integration	Running CodeQL semantic analysis
CLI Reference	Complete command-line options
Examples	Real-world usage examples
Development	Contributing and development setup

Building the Docs

# Install MkDocs
pip install mkdocs mkdocs-material

# Serve locally
mkdocs serve

# Build static site
mkdocs build

🛠️ Development

# Setup development environment
make dev

# Run tests
make test

# Run all checks (lint, typecheck, test)
make check

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes and ensure tests pass (make check)
4. Commit and push to your branch
5. Open a Pull Request

See Development Guide for detailed instructions.

🙏 Acknowledgments

• GitHub API for code search capabilities
• Semgrep for static analysis
• CodeQL for semantic analysis

---

Made with ❤️ for the security research community