Skip to main content

Extract and analyze codebases from GitHub or local directories using AI (SOLID, Design Patterns, Security, Architecture)

Project description

🚀 CodePeek 2.0

AI-Powered Codebase Analyzer & Summarizer

CodePeek helps you understand any codebase — local or from GitHub — using AI analysis.
It extracts structure, reviews SOLID violations, suggests Design Patterns,
detects security issues, and exports a clean PDF report.


🌟 Features

✅ Analyze any local project or GitHub repository
✅ Detect SOLID principle violations
✅ Recommend Design Patterns
✅ Find Security & Architecture issues
✅ Generate a professional PDF report
✅ Powered by Mistral AI (fast, free-tier support)


🧠 How It Works

  1. Extracts your code structure and reads all source files.
  2. Summarizes each file intelligently.
  3. Sends the summary to an AI model for deep code review.
  4. Generates a full visual PDF report with categorized findings.

🛠️ Installation

pip install codepeek

Requires Python 3.8+


⚙️ Setup

Create a .env file in your project root with your Mistral API key:

MISTRAL_API_KEY=your_api_key_here

If you don’t have one yet, get it from https://console.mistral.ai


💡 Usage

🔍 Analyze a Local Project

codepeek analyze -p "C:\path\to\project"

🌐 Analyze a GitHub Repository

codepeek analyze-github https://github.com/user/repo

🧾 Summarize (Extract Only)

codepeek summarize https://github.com/user/repo output.txt

📄 Output Example

After analysis, you’ll get:

  • A PDF reportprojectname_report.pdf
  • With structured sections like:
    • SOLID Principles
    • Design Patterns
    • Security Issues
    • Architecture Recommendations
    • Final Recommendations

🧰 Dependencies

  • requests
  • reportlab
  • python-dotenv
  • tqdm

🧑‍💻 Author

Ahmed Abd Alzeez
GitHubEmail


📜 License

MIT License © 2025 Ahmed Abd Alzeez

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

codepeek-2.0.2.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

codepeek-2.0.2-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file codepeek-2.0.2.tar.gz.

File metadata

  • Download URL: codepeek-2.0.2.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for codepeek-2.0.2.tar.gz
Algorithm Hash digest
SHA256 4c5f5915ac02c58659177d0a96c9da75771ca73884bd46bb719139f78219d35f
MD5 4e0ae6092e3293ccb6944becd24d2bc6
BLAKE2b-256 3a647210ef9e0d6822bf7e077013305466c1e7a3a5d0c2a83043ee6aa45fa527

See more details on using hashes here.

File details

Details for the file codepeek-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: codepeek-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for codepeek-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 72e00ff828b1bba22927bbd6298780bb74884c9460e5b4a5bf5ad2b939e30aed
MD5 09618f78007c2640a18469a77c19059b
BLAKE2b-256 f0b2aec9941aa1a9e1e88b9b0cc92e232af8b29a76406048d9cf35ddce070abe

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