python-code-quality-analyzer 3.0.8

A powerful tool for analyzing Python code complexity, quality, and maintainability

Python Code Quality Analyzer

A powerful tool for analyzing Python code complexity, quality, and maintainability. Get insights into your codebase with detailed metrics and actionable recommendations for improvement.

Features

• 📊 Complexity Analysis: Calculate cyclomatic complexity for functions and files
• 🎯 Quality Metrics: Measure maintainability index and identify problematic areas
• 🔍 Detailed Reports: Get comprehensive reports in console, JSON, or CSV format
• ⚡ Fast & Efficient: Analyze large codebases quickly with minimal overhead
• 🎨 Beautiful Output: Rich console output with tables and color-coding
• ⚙️ Configurable: Customize analysis with exclude patterns and complexity thresholds
• 📋 Actionable Insights: Clear recommendations for code improvement

Installation

pip install python-code-quality-analyzer

Quick Start

Basic usage:

python-code-quality-analyzer analyze .

Examples

Verbose output:

python-code-quality-analyzer analyze . --verbose

Set minimum complexity threshold:

python-code-quality-analyzer analyze . --min-complexity 10

Output to JSON:

python-code-quality-analyzer analyze . --format json > analysis.json

Usage

The basic command structure is:

python-code-quality-analyzer analyze /path/to/your/project

Options

• --verbose, -v: Show detailed output
• --format, -f: Output format (text, json, csv)
• --min-complexity, -m: Minimum complexity threshold
• --exclude, -e: Exclude patterns (glob)
• --config, -c: Path to config file

Examples

# Verbose output
python-code-quality-analyzer analyze . --verbose

# Export to CSV
python-code-quality-analyzer analyze . --format csv > analysis.csv

# Set complexity threshold
python-code-quality-analyzer analyze . --min-complexity 10

# Exclude patterns
python-code-quality-analyzer analyze . --exclude "**/tests/*" --exclude "**/vendor/*"

# Use custom config
python-code-quality-analyzer analyze . --config myconfig.yaml

Configuration

The analyzer can be configured using a YAML configuration file. Create a file named .python-code-quality-analyzer.yaml in your project root:

# Complexity thresholds
complexity:
  max: 10
  warning: 7

# Output format
format: text

# Exclude patterns
exclude:
  - "**/tests/*"
  - "**/vendor/*"
  - "**/__pycache__/*"

# Analysis options
analyze:
  maintainability: true
  halstead: true
  cyclomatic: true

Output Example

         Project Overview                                    
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┓
┃ Metric             ┃ Value ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━┩
│ Total Files        │ 25    │
│ Total Functions    │ 150   │
│ Average Complexity │ 3.45  │
└────────────────────┴───────┘

         Code Quality                                    
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┓
┃ Metric             ┃ Value ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━┩
│ Average MI         │ 65.42 │
│ Total Complexity   │ 517   │
└────────────────────┴───────┘

      Action Items
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ • High Priority:                                    ┃
┃   - Refactor cli.py (complexity: 202, MI: 0.0)     ┃
┃   - Split performance.py into smaller modules       ┃
┃                                                    ┃
┃ • Medium Priority:                                 ┃
┃   - Improve maintainability of history.py          ┃
┃   - Break down complex functions in ai.py          ┃
┃                                                    ┃
┃ • Consider:                                        ┃
┃   - Reducing dependencies in network.py            ┃
┃   - Adding documentation to low MI files           ┃
└────────────────────────────────────────────────────┘

JSON Output Structure

The JSON output provides detailed metrics for programmatic analysis:

{
  "summary": {
    "total_files": 25,
    "total_functions": 150,
    "average_complexity": 3.45,
    "average_maintainability": 65.42
  },
  "complex_files": [...],
  "low_maintainability_files": [...],
  "recommendations": [...],
  "detailed_metrics": {
    "file.py": {
      "complexity": 10,
      "maintainability": 65.4,
      "dependencies": [...],
      "functions": 5
    }
  }
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development Setup

1. Clone the repository:

   git clone https://github.com/kareemaly/python-code-quality-analyzer.git
   cd python-code-quality-analyzer
   

2. Create and activate a virtual environment:

   python -m venv .venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   

3. Install development dependencies:

   pip install -e .[dev]
   

4. Run tests:

   pytest
   

Release Process

Releases are managed through GitHub Actions. To create a new release:

1. Go to the Actions tab in the repository
2. Select the "Release" workflow
3. Click "Run workflow"
4. Choose the version bump type (patch, minor, or major)
5. Enter the release notes
6. Click "Run workflow"

The workflow will:

• Update version numbers
• Run tests
• Build the package
• Publish to PyPI
• Create a GitHub release

License

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