Metadata-Version: 2.4
Name: code2flow-visualizer
Version: 0.8.6
Summary: Real-Time Code Execution Visualizer for Python
Home-page: https://github.com/Aryan0854/code2flow-visualizer
Author: Aryan Mishra
Author-email: aryanmishra.dev@gmail.com
Project-URL: Repository, https://github.com/Aryan0854/code2flow-visualizer
Project-URL: Bug Tracker, https://github.com/Aryan0854/code2flow-visualizer/issues
Project-URL: Documentation, https://github.com/Aryan0854/code2flow-visualizer#readme
Keywords: debugging visualization flowchart code-analysis
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Debuggers
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: graphviz>=0.20.0
Requires-Dist: jupyter>=1.0.0
Requires-Dist: ipython>=8.0.0
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: networkx>=2.8.0
Requires-Dist: pydot>=1.4.0
Requires-Dist: ast-decompiler>=0.8.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: flake8>=5.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: jupyter-notebook>=6.4.0; extra == "dev"
Provides-Extra: mermaid
Requires-Dist: mermaid-py>=0.1.0; extra == "mermaid"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Code2Flow Visualizer 🔄

[![PyPI version](https://badge.fury.io/py/code2flow-visualizer.svg)](https://badge.fury.io/py/code2flow-visualizer)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

**Real-Time Code Execution Visualizer for Python**

> 🎉 **Now available on PyPI!** Install with `pip install code2flow-visualizer`

Code2Flow Visualizer is a powerful debugging and visualization library that generates interactive flowcharts of Python code execution. Watch your variables change step-by-step and understand complex logic flow like never before.

## ✨ Features

- 🔍 **Step-by-step execution visualization** - See how variables change during code execution
- 📊 **Interactive flowcharts** - Navigate through execution paths visually  
- 📝 **Jupyter Notebook integration** - Works seamlessly in your favorite environment
- 🎨 **Multiple export formats** - Export to Mermaid.js, Graphviz, PNG, SVG
- 🚀 **Real-time debugging** - Like Python Tutor but more powerful and flexible
- 🔧 **Customizable visualization** - Configure colors, layout, and display options

## 🚀 Quick Start

```bash
pip install code2flow-visualizer
```

### Basic Usage

```python
from code2flow import visualize

@visualize
def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

# This will generate an interactive flowchart
result = fibonacci(5)
```

### Jupyter Notebook

```python
from code2flow import FlowVisualizer

visualizer = FlowVisualizer()
visualizer.track_function(your_function)
visualizer.display()  # Shows interactive widget
```

### Export Options

```python
from code2flow import CodeFlow

flow = CodeFlow()
flow.trace(your_code)
flow.export_mermaid("flowchart.md")
flow.export_graphviz("flowchart.dot")
flow.export_image("flowchart.png")
```

## 🛠️ Installation

### Basic Installation
```bash
pip install code2flow-visualizer
```

### Development Installation
```bash
pip install code2flow-visualizer[dev]
```

### With Mermaid Support
```bash
pip install code2flow-visualizer[mermaid]
```

## 📖 Documentation

- [Getting Started Guide](docs/getting_started.md)
- [API Reference](docs/api_reference.md)
- [Examples](examples/)
- [Contributing](CONTRIBUTING.md)

## 🎯 Why Code2Flow Visualizer?

Traditional debugging tools show you *where* your code fails, but Code2Flow Visualizer shows you *how* your code behaves. Perfect for:

- Understanding complex algorithms
- Teaching programming concepts  
- Debugging recursive functions
- Visualizing data flow in applications
- Code reviews and documentation

## 📊 Example Output

```
┌─────────────────┐
│ fibonacci(5)    │
│ n = 5          │
└─────┬───────────┘
      │
      ▼
┌─────────────────┐
│ n > 1 ?        │
│ True           │
└─────┬───────────┘
      │
      ▼
┌─────────────────┐
│ fibonacci(4) +  │
│ fibonacci(3)    │
└─────────────────┘
```

## 🤝 Contributing

We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## 📄 License

MIT License - see [LICENSE](LICENSE) file for details.

## 🙋‍♂️ Support

- 🐛 [Report bugs](https://github.com/Aryan0854/code2flow-visualizer/issues)
- 💡 [Request features](https://github.com/Aryan0854/code2flow-visualizer/issues)
- 💬 [Join discussions](https://github.com/Aryan0854/code2flow-visualizer/discussions)

---

Made with ❤️ for the Python community
