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.1.tar.gz (13.2 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.1-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: codepeek-2.0.1.tar.gz
  • Upload date:
  • Size: 13.2 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.1.tar.gz
Algorithm Hash digest
SHA256 c24c4033b7b04c5932679ac7ea7032182014b90ea7fc335a06c83dc234403b38
MD5 d72d730a217639214aeefbdbb54ad0fe
BLAKE2b-256 235ddd5411895d041045dc500f425552144a4e02d926353d044031a27d1bda22

See more details on using hashes here.

File details

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

File metadata

  • Download URL: codepeek-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 14.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 308f337b03576401a1472c740e2d91986d0072fe17c4912f1f8fca19a7cf05c2
MD5 0c38e2534f81d54e497da541397b4dba
BLAKE2b-256 a94c0fccf7db49d6e4aa36c0c5fa04c4c50f773344d4f747a1554c5a71a6bcf6

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