Complete documentation index for CallFlow Tracer.

📚 Documentation Structure

🆕 Latest Release Notes

🚀 Getting Started

  1. README.md - Main introduction and quick start
  2. INSTALLATION_GUIDE.md - Installation and setup
  3. USER_GUIDE.md - Complete user guide
  4. QUICK_TEST.md - Quick testing reference

📖 Core Documentation

  1. API_DOCUMENTATION.md - Complete API reference
  2. FEATURES_COMPLETE.md - All features explained
  3. CHANGELOG.md - Version history and changes

🔥 Feature-Specific Guides

  1. FLAMEGRAPH_README.md - Flamegraph guide
  2. ENHANCED_FEATURES.md - Enhanced features
  3. FLAMEGRAPH_SUMMARY.md - Flamegraph summary
  4. JUPYTER_README.md - Jupyter integration

🆕 New Features (v0.3.0)

  1. NEW_FEATURES_INDEX.md - New features overview and index
  2. CLI_GUIDE.md - Command-line interface guide
  3. CODE_QUALITY_GUIDE.md - Code quality analysis
  4. PREDICTIVE_ANALYSIS_GUIDE.md - Predictive analytics
  5. CODE_CHURN_GUIDE.md - Code churn analysis
  6. INTEGRATIONS_GUIDE.md - Framework integrations

🧪 Testing Documentation

  1. TESTING_GUIDE.md - Comprehensive testing guide
  2. Test Files: tests/test_*.py - Automated test suites

💡 Examples

  1. Example Files: examples/*.py - Runnable examples
  2. Jupyter Notebook: examples/jupyter_example.ipynb - Interactive examples

📋 Quick Navigation

By Topic

Tracing

Profiling

Flamegraphs

Call Graphs

Export

New in v0.2.4

New in v0.3.0

By Use Case

Finding Performance Bottlenecks

  1. Quick Performance Check
  2. Flamegraph Analysis
  3. Performance Color Scheme
  4. Statistics Panel

Understanding Code Flow

  1. Basic Tracing
  2. Call Graph Visualization
  3. Layout Options
  4. Module Filtering

Optimizing Performance

  1. Before/After Comparison
  2. Comprehensive Analysis
  3. Profiling Guide

Interactive Development

  1. Jupyter Setup
  2. Inline Visualization
  3. Magic Commands
  4. Interactive Workflow

Creating Reports

  1. Export Options
  2. Custom Titles
  3. Automated Reporting

🔍 By Feature

Core Features

Visualization Features

Profiling Features

Flamegraph Features

Jupyter Features

Export Features

UI/UX Features

📊 By Skill Level

Beginner

  1. Start with README.md
  2. Follow Quick Start
  3. Run Basic Examples
  4. Read User Guide

Intermediate

  1. Read API Documentation
  2. Explore All Features
  3. Try Enhanced Features
  4. Run All Examples

Advanced

  1. Study Source Code
  2. Read Testing Guide
  3. Contribute features
  4. Integrate with CI/CD

🎓 Learning Path

Week 1: Basics

Week 2: Profiling

Week 3: Flamegraphs

Week 4: Advanced

📖 Documentation Files

Main Documentation (Root)

| File | Description | Lines | |——|————-|——-| | README.md | Main introduction | 674 | | CHANGELOG.md | Version history | 500+ | | TESTING_GUIDE.md | Testing guide | 500+ | | QUICK_TEST.md | Quick reference | 165 | | ENHANCED_FEATURES.md | Enhanced features | 300+ | | FLAMEGRAPH_SUMMARY.md | Flamegraph overview | 400+ |

Documentation Directory (docs/)

| File | Description | Lines | |——|————-|——-| | API_DOCUMENTATION.md | Complete API reference | 600+ | | FEATURES_COMPLETE.md | All features | 800+ | | INSTALLATION_GUIDE.md | Installation guide | 400+ | | USER_GUIDE.md | User guide | 700+ | | INDEX.md | This file | 500+ | | NEW_FEATURES_INDEX.md | New features index (v0.3.0) | 400+ | | CLI_GUIDE.md | CLI guide (v0.3.0) | 150+ | | CODE_QUALITY_GUIDE.md | Code quality guide (v0.3.0) | 200+ | | PREDICTIVE_ANALYSIS_GUIDE.md | Predictive analysis guide (v0.3.0) | 220+ | | CODE_CHURN_GUIDE.md | Code churn guide (v0.3.0) | 200+ | | INTEGRATIONS_GUIDE.md | Integrations guide (v0.3.0) | 250+ |

Examples Directory (examples/)

| File | Description | Lines | |——|————-|——-| | FLAMEGRAPH_README.md | Flamegraph guide | 400+ | | JUPYTER_README.md | Jupyter guide | 400+ | | flamegraph_example.py | 7 examples | 500+ | | flamegraph_enhanced_demo.py | 12 examples | 700+ | | jupyter_example.ipynb | Notebook | - | | jupyter_standalone_demo.py | Standalone demos | 600+ |

Tests Directory (tests/)

| File | Description | Tests | |——|————-|——-| | test_flamegraph.py | Flamegraph tests | 10 | | test_flamegraph_enhanced.py | Enhanced tests | 10 | | test_jupyter_integration.py | Jupyter tests | 7 | | test_cprofile_fix.py | CPU profiling tests | 2 |

🔗 External Resources

Dependencies

📊 Statistics

Documentation Coverage

Package Statistics

v0.3.0 New Features

🎯 Quick Links

Most Important Documents

  1. README.md - Start here!
  2. USER_GUIDE.md - Complete usage guide
  3. API_DOCUMENTATION.md - API reference
  4. ENHANCED_FEATURES.md - Enhanced features
  5. NEW_FEATURES_INDEX.md - New v0.3.0 features

Most Useful Examples

  1. flamegraph_enhanced_demo.py - All features
  2. jupyter_example.ipynb - Jupyter examples
  3. flamegraph_example.py - Basic examples

Most Important Tests

  1. test_flamegraph_enhanced.py - Enhanced features
  2. test_cprofile_fix.py - CPU profiling
  3. test_jupyter_integration.py - Jupyter

🎓 Recommended Reading Order

For New Users

  1. README.md - Overview
  2. INSTALLATION_GUIDE.md - Setup
  3. USER_GUIDE.md - Usage
  4. Run examples
  5. QUICK_TEST.md - Verify

For Developers

  1. API_DOCUMENTATION.md - API
  2. FEATURES_COMPLETE.md - Features
  3. TESTING_GUIDE.md - Testing
  4. Source code
  5. Contribute

For Performance Analysis

  1. ENHANCED_FEATURES.md - New features
  2. FLAMEGRAPH_README.md - Flamegraphs
  3. USER_GUIDE.md - Analysis guide
  4. Run examples

For Jupyter Users

  1. JUPYTER_README.md - Jupyter guide
  2. jupyter_example.ipynb - Notebook
  3. USER_GUIDE.md - Jupyter section
  4. Run demos

🔍 Search by Keyword

Tracing

Profiling

Flamegraph

Visualization

Jupyter

Export

📦 Package Contents

Source Code (callflow_tracer/)

callflow_tracer/
├── __init__.py              # Main API exports
├── tracer.py                # Core tracing (CallTracer, CallGraph, CallNode)
├── exporter.py              # HTML/JSON export functions
├── profiling.py             # Performance profiling (CPU, memory, I/O)
├── flamegraph.py            # Flamegraph generation
├── flamegraph_enhanced.py   # Enhanced flamegraph UI
└── jupyter.py               # Jupyter integration (magic commands, display)

Examples (examples/)

examples/
├── flamegraph_example.py           # 7 basic flamegraph examples
├── flamegraph_enhanced_demo.py     # 12 enhanced feature demos
├── jupyter_example.ipynb           # Interactive Jupyter notebook
├── jupyter_standalone_demo.py      # 5 standalone Jupyter demos
├── FLAMEGRAPH_README.md            # Complete flamegraph guide
└── JUPYTER_README.md               # Complete Jupyter guide

Tests (tests/)

tests/
├── test_flamegraph.py              # 10 flamegraph tests
├── test_flamegraph_enhanced.py     # 10 enhanced feature tests
├── test_jupyter_integration.py     # 7 Jupyter integration tests
└── test_cprofile_fix.py            # CPU profiling fix tests

Documentation (docs/)

docs/
├── API_DOCUMENTATION.md            # Complete API reference
├── FEATURES_COMPLETE.md            # All features documented
├── INSTALLATION_GUIDE.md           # Installation and setup
├── USER_GUIDE.md                   # Complete user guide
└── INDEX.md                        # This file

🎨 Visual Guide

What Each Visualization Shows

Call Graph (export_html)

┌─────────────────────────────────────┐
│         main()                      │
│    (100ms, 1 call)                 │
└──────────┬──────────────────────────┘
           │
     ┌─────┴─────┬─────────────┐
     │           │             │
┌────▼────┐ ┌───▼────┐  ┌────▼────┐
│ load()  │ │process()│  │ save()  │
│ 20ms    │ │  60ms   │  │  20ms   │
└─────────┘ └─────────┘  └─────────┘

Shows: Function relationships and call hierarchy

Flamegraph (generate_flamegraph)

┌─────────────────────────────────────┐
│         main() - 100ms              │
├──────────────┬──────────────────────┤
│  load()      │    process()         │
│   20ms       │     60ms             │
├──────┬───────┼──────┬───────────────┤
│ db   │ cache │ step1│    step2      │
│ 15ms │  5ms  │ 20ms │     40ms      │
└──────┴───────┴──────┴───────────────┘

Shows: Time distribution and bottlenecks (width = time)

🚀 Quick Commands

Installation

pip install callflow-tracer

Run Tests

python tests/test_flamegraph_enhanced.py

Run Examples

python examples/flamegraph_enhanced_demo.py

Generate Documentation

# All documentation is already generated!
# Just read the markdown files

📞 Getting Help

Documentation

  1. Check this index for relevant docs
  2. Read the specific guide
  3. Try the examples
  4. Run the tests

Community

  1. Search GitHub issues
  2. Ask in Discussions
  3. Create new issue
  4. Email support

Support Channels

✅ Documentation Checklist

For Users

For Developers

For Contributors

🎉 Summary

CallFlow Tracer includes:

Everything you need to:

🆕 v0.3.0 New Features

Major Additions

  1. Command-Line Interface - 10 CLI commands
  2. Code Quality Analysis - Complexity, maintainability, debt metrics
  3. Predictive Analysis - Performance prediction, capacity planning
  4. Code Churn Analysis - Git history analysis, hotspot identification
  5. Framework Integrations - Flask, FastAPI, Django, SQLAlchemy, psycopg2

New Documentation

Documentation Index - Last Updated: 2025-01-15

Start with README.md or NEW_FEATURES_INDEX.md to explore! 🚀