Complete index and mapping of all newly created features.

📋 Table of Contents

  1. Feature Overview
  2. Documentation Mapping
  3. Module Structure
  4. Quick Reference
  5. Integration Map

Feature Overview

New Features in v0.3.0

Feature Module Type Status
Command-Line Interface cli.py Core ✅ Complete
Code Quality Analysis code_quality.py Analysis ✅ Complete
Predictive Analysis predictive_analysis.py Analysis ✅ Complete
Code Churn Analysis code_churn.py Analysis ✅ Complete
Flask Integration integrations/flask_integration.py Integration ✅ Complete
FastAPI Integration integrations/fastapi_integration.py Integration ✅ Complete
Django Integration integrations/django_integration.py Integration ✅ Complete
SQLAlchemy Integration integrations/sqlalchemy_integration.py Integration ✅ Complete
psycopg2 Integration integrations/psycopg2_integration.py Integration ✅ Complete

Documentation Mapping

1. CLI Guide

File: docs/CLI_GUIDE.md

Covers:

Commands:

2. Code Quality Guide

File: docs/CODE_QUALITY_GUIDE.md

Covers:

Key Classes:

Metrics:

3. Predictive Analysis Guide

File: docs/PREDICTIVE_ANALYSIS_GUIDE.md

Covers:

Key Classes:

Predictions:

4. Code Churn Guide

File: docs/CODE_CHURN_GUIDE.md

Covers:

Key Classes:

Metrics:

5. Integrations Guide

File: docs/INTEGRATIONS_GUIDE.md

Covers:

Integrations:

Module Structure

Core Modules

callflow_tracer/
├── cli.py (850 lines)
│   ├── CallflowCLI class
│   ├── 10 command handlers
│   └── HTML report generation
│
├── code_quality.py (633 lines)
│   ├── ComplexityMetrics dataclass
│   ├── MaintainabilityMetrics dataclass
│   ├── TechnicalDebtIndicator dataclass
│   ├── QualityTrend dataclass
│   ├── ComplexityAnalyzer class
│   ├── MaintainabilityAnalyzer class
│   ├── TechnicalDebtAnalyzer class
│   ├── QualityTrendAnalyzer class
│   └── analyze_codebase() function
│
├── predictive_analysis.py (627 lines)
│   ├── PerformancePrediction dataclass
│   ├── CapacityPrediction dataclass
│   ├── ScalabilityAnalysis dataclass
│   ├── ResourceForecast dataclass
│   ├── PerformancePredictor class
│   ├── CapacityPlanner class
│   ├── ScalabilityAnalyzer class
│   ├── ResourceForecaster class
│   └── generate_predictive_report() function
│
├── code_churn.py (382 lines)
│   ├── ChurnMetrics dataclass
│   ├── ChurnCorrelation dataclass
│   ├── CodeChurnAnalyzer class
│   ├── ChurnCorrelationAnalyzer class
│   └── generate_churn_report() function
│
└── integrations/
    ├── __init__.py
    ├── flask_integration.py (2586 bytes)
    ├── fastapi_integration.py (2105 bytes)
    ├── django_integration.py (2586 bytes)
    ├── sqlalchemy_integration.py (1725 bytes)
    └── psycopg2_integration.py (3744 bytes)

Quick Reference

CLI Commands Quick Reference

# Tracing
callflow-tracer trace script.py -o output.html
callflow-tracer flamegraph script.py -o flamegraph.html
callflow-tracer profile script.py --memory --cpu

# Analysis
callflow-tracer quality . -o quality_report.html
callflow-tracer predict history.json -o predictions.html
callflow-tracer churn . -o churn_report.html

# Utilities
callflow-tracer compare trace1.json trace2.json -o comparison.html
callflow-tracer export trace.json -o output.html --format html
callflow-tracer info trace.json --detailed
callflow-tracer memory-leak script.py -o report.html

Python API Quick Reference

# Code Quality
from callflow_tracer.code_quality import analyze_codebase
results = analyze_codebase("./src")

# Predictive Analysis
from callflow_tracer.predictive_analysis import PerformancePredictor
predictor = PerformancePredictor("history.json")
predictions = predictor.predict_performance_issues(current_trace)

# Code Churn
from callflow_tracer.code_churn import generate_churn_report
report = generate_churn_report(".", days=90)

# Framework Integration
from callflow_tracer.integrations.flask_integration import setup_flask_tracing
setup_flask_tracing(app)

Integration Map

Framework Support Matrix

Framework Module Type Features
Flask flask_integration.py Web Request tracing, endpoint profiling
FastAPI fastapi_integration.py Web Async support, endpoint profiling
Django django_integration.py Web Middleware, view tracing, DB monitoring
SQLAlchemy sqlalchemy_integration.py ORM Query tracing, performance monitoring
psycopg2 psycopg2_integration.py DB Query tracing, connection monitoring

Integration Setup Patterns

Web Frameworks

from callflow_tracer.integrations.{framework}_integration import setup_{framework}_tracing
setup_{framework}_tracing(app, output_dir="traces")

Database Libraries

from callflow_tracer.integrations.{db}_integration import setup_{db}_tracing
setup_{db}_tracing(connection_or_engine)

Feature Capabilities

Code Quality Analysis

Predictive Analysis

Code Churn Analysis

Framework Integrations

Statistics

Code Metrics

Documentation

Test Coverage

Learning Path

Beginner

  1. Read CLI_GUIDE.md
  2. Try CLI commands
  3. Generate first quality report
  4. Explore output formats

Intermediate

  1. Read CODE_QUALITY_GUIDE.md
  2. Read CODE_CHURN_GUIDE.md
  3. Use Python API
  4. Integrate with CI/CD

Advanced

  1. Read PREDICTIVE_ANALYSIS_GUIDE.md
  2. Read INTEGRATIONS_GUIDE.md
  3. Combine multiple analyses
  4. Create custom workflows

Cross-Reference

By Use Case

Finding Code Quality Issues

Identifying High-Risk Files

Predicting Performance Issues

Integrating with Web Frameworks

By Module

cli.py

code_quality.py

predictive_analysis.py

code_churn.py

integrations/

Version Information

Next Steps

  1. Read the guides in order of interest
  2. Try the CLI commands to get familiar
  3. Use the Python API for programmatic access
  4. Integrate with frameworks for automatic tracing
  5. Combine analyses for comprehensive insights

Documentation Index - New Features v0.3.0 Last Updated: 2025-01-15