A comprehensive, intelligent tool that analyzes GitHub repositories for test coverage, code quality, security, and performance. Now featuring AI-powered insights for deeper analysis and intelligent recommendations!
- Repository Analysis: Deep analysis of both public and private GitHub repositories
- Test Coverage: Automated test case coverage analysis with multiple language support
- Issue Detection: Identifies main issues and suggests corrective actions
- Interactive Dashboard: Web-based interface with public/private repository selection
- Improvement Suggestions: Detailed recommendations for code quality enhancement
- No Token Required: Analyze public repositories without authentication
- Intelligent Code Review: Context-aware analysis beyond simple pattern matching
- Smart Security Analysis: Advanced vulnerability detection using AI reasoning
- Architecture Assessment: AI-powered evaluation of code structure and complexity
- Performance Optimization: Intelligent suggestions for algorithmic improvements
- Automated Documentation: Missing docs detection with AI-generated suggestions
- Strategic Roadmap: AI-generated implementation timeline with priority matrix
- Confidence Scoring: AI provides reliability scores for all recommendations
# Run the setup script to configure the environment
./scripts/deployment/setup.sh# Start the application
./scripts/deployment/start_app.sh
# Stop the application
./scripts/deployment/stop_app.sh
# Monitor application logs
./scripts/deployment/monitor_logs.sh# Start the application
scripts\deployment\start_app.bat
# Stop the application
scripts\deployment\stop_app.bat# Start CodePulse with Docker (from project root)
./docker-quick.sh
# View logs
./docker-quick.sh logs
# Stop application
./docker-quick.sh stop# Production mode
./docker/docker-manage.sh run
# Development mode
./docker/docker-manage.sh dev
# Check status
./docker/docker-manage.sh status
# Or use Docker Compose directly
cd docker && docker compose up -d- Docker Engine 20.10+
- Docker Compose 2.0+
- 2GB RAM minimum
- β Production Ready: Optimized containers with health checks
- β Development Mode: Live code reloading for development
- β Security: Non-root execution, isolated networks
- β Monitoring: Built-in logging and health monitoring
- β Scalability: Easy horizontal scaling with compose
π Full Docker Documentation: docker/README.md
-
Install Dependencies:
pip install -r requirements.txt
-
Run the Application:
python app.py
-
Access Dashboard: Open http://localhost:5050 in your browser
-
Set Up GitHub Token (Required for AI features):
cp .env.example .env # Edit .env and add your GitHub token GITHUB_TOKEN=your_github_token_here -
Restart Application:
python app.py
-
Enable AI Analysis:
- Check "Enable AI-Enhanced Analysis" in the web interface
- Experience intelligent insights and recommendations!
python app_enhanced.py
-
Enable AI Analysis:
- Visit http://localhost:5050
- Check "Enable AI-Enhanced Analysis" option
- Experience intelligent insights!
- Enter a GitHub repository URL in the dashboard
- Check "This is a public repository" for public repos (no token needed)
- Uncheck for private repositories (requires GitHub token in .env)
- Click "Analyze Repository"
- View comprehensive test coverage analysis and basic recommendations
- Ensure you have a GitHub token configured in
.env - Enter a repository URL
- Enable "AI-Enhanced Analysis" checkbox
- Click "AI-Enhanced Analysis" button
- Get intelligent insights including:
- Context-aware code quality assessment
- AI-powered security vulnerability analysis
- Performance optimization suggestions
- Strategic improvement roadmap
- ROI projections for improvements
βββ app.py # Unified Flask application with AI features
βββ config.py # Configuration settings
βββ requirements.txt # Python dependencies
βββ .env # Environment variables (create this)
βββ analyzer/ # Core analysis modules
β βββ __init__.py
β βββ github_client.py # GitHub API client
β βββ test_analyzer.py # Test coverage analysis
β βββ issue_detector.py # Issue detection logic
β βββ report_generator.py # Standard report generation
β βββ ai_analyzer.py # π§ AI analysis engine
β βββ enhanced_report_generator.py # π AI-enhanced reporting
βββ templates/ # HTML templates
β βββ base.html
β βββ index.html # Main dashboard with AI toggle
β βββ results.html # Standard analysis results
β βββ results_enhanced.html # π¨ AI-enhanced results page
β βββ ...
βββ static/ # Static assets
β βββ css/
β β βββ style.css # Enhanced styling
β βββ js/
β βββ main.js # Interactive features
βββ scripts/ # Utility scripts
β βββ test_ai_compatibility.py # AI feature testing
β βββ test_app.py # Application testing
βββ tests/ # Test suite
βββ docs/ # Documentation
βββ AI_ENHANCEMENT_SUMMARY.md
βββ PROJECT_STRUCTURE.md
Create a .env file from the example:
cp .env.example .envRequired for AI features:
# GitHub Personal Access Token
GITHUB_TOKEN=your_github_token_here
# Optional settings
DEBUG=True
SECRET_KEY=your-secret-key- Go to GitHub Settings: https://github.com/settings/tokens
- Generate new token with these scopes:
repo(for private repositories)public_repo(for public repositories)
- Copy token to your
.envfile
| Model | Use Case | Cost | Quality |
|---|---|---|---|
gpt-4.1-mini |
General analysis (default) | Low | High |
gpt-4.1 |
Comprehensive analysis | Medium | Very High |
codestral-2501 |
Code-specific tasks | Low | High |
o1-mini |
Complex reasoning | High | Very High |
| Feature | Standard | AI-Enhanced |
|---|---|---|
| Speed | Fast | Moderate |
| Depth | Basic patterns | Deep understanding |
| Accuracy | Good | Excellent |
| Recommendations | Generic | Tailored |
| Roadmap | Basic | Strategic |
| Cost | Free | $0.10-10.00/analysis |
β
Test Coverage: 75%
β οΈ Security Issues: 3 found
π Documentation: Missing in 12 filesπ§ AI Quality Score: 82/100
π¨ Critical: SQL injection in auth/login.py (2-4 hours fix)
β‘ Performance: Implement Redis caching (15% speed improvement)
π Roadmap: 4-phase improvement plan (6 months)
π° ROI: 25% development velocity increase- AI Improvements Guide: Comprehensive AI enhancement documentation
- API Documentation: REST API reference
- Contributing Guidelines: How to contribute to the project β βββ results.html βββ static/ # CSS, JS, and assets β βββ css/ β βββ js/ β βββ images/ βββ tests/ # Unit tests βββ init.py βββ test_github_client.py βββ test_analyzer.py βββ test_issue_detector.py
## Usage
1. Enter a GitHub repository URL in the dashboard
2. View comprehensive test coverage analysis
3. Review identified issues and improvement areas
4. Follow suggested corrective actions
## Development
To run tests:
```bash
pytest tests/ --cov=analyzer
To run in development mode:
export FLASK_ENV=development
python app.pyMIT License# CodePulse