code2flow-visualizer


Namecode2flow-visualizer JSON
Version 0.8.1 PyPI version JSON
download
home_pagehttps://github.com/Aryan0854/code2flow-visualizer
SummaryReal-Time Code Execution Visualizer for Python
upload_time2025-08-06 19:30:54
maintainerNone
docs_urlNone
authorAryan Mishra
requires_python>=3.8
licenseNone
keywords debugging visualization flowchart code-analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Aryan0854/code2flow-visualizer",
    "name": "code2flow-visualizer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "debugging visualization flowchart code-analysis",
    "author": "Aryan Mishra",
    "author_email": "aryanmishra.dev@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d9/af/fbdf7e38c2e774b5e79ebe53934d7071acd69b669ee21aa50e06e509ef2b/code2flow_visualizer-0.8.1.tar.gz",
    "platform": null,
    "description": "# Code2Flow Visualizer \ud83d\udd04\r\n\r\n[![PyPI version](https://badge.fury.io/py/code2flow-visualizer.svg)](https://badge.fury.io/py/code2flow-visualizer)\r\n[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)\r\n\r\n**Real-Time Code Execution Visualizer for Python**\r\n\r\n> \ud83c\udf89 **Now available on PyPI!** Install with `pip install code2flow-visualizer`\r\n\r\nCode2Flow 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.\r\n\r\n## \u2728 Features\r\n\r\n- \ud83d\udd0d **Step-by-step execution visualization** - See how variables change during code execution\r\n- \ud83d\udcca **Interactive flowcharts** - Navigate through execution paths visually  \r\n- \ud83d\udcdd **Jupyter Notebook integration** - Works seamlessly in your favorite environment\r\n- \ud83c\udfa8 **Multiple export formats** - Export to Mermaid.js, Graphviz, PNG, SVG\r\n- \ud83d\ude80 **Real-time debugging** - Like Python Tutor but more powerful and flexible\r\n- \ud83d\udd27 **Customizable visualization** - Configure colors, layout, and display options\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n```bash\r\npip install code2flow-visualizer\r\n```\r\n\r\n### Basic Usage\r\n\r\n```python\r\nfrom code2flow import visualize\r\n\r\n@visualize\r\ndef fibonacci(n):\r\n    if n <= 1:\r\n        return n\r\n    return fibonacci(n-1) + fibonacci(n-2)\r\n\r\n# This will generate an interactive flowchart\r\nresult = fibonacci(5)\r\n```\r\n\r\n### Jupyter Notebook\r\n\r\n```python\r\nfrom code2flow import FlowVisualizer\r\n\r\nvisualizer = FlowVisualizer()\r\nvisualizer.track_function(your_function)\r\nvisualizer.display()  # Shows interactive widget\r\n```\r\n\r\n### Export Options\r\n\r\n```python\r\nfrom code2flow import CodeFlow\r\n\r\nflow = CodeFlow()\r\nflow.trace(your_code)\r\nflow.export_mermaid(\"flowchart.md\")\r\nflow.export_graphviz(\"flowchart.dot\")\r\nflow.export_image(\"flowchart.png\")\r\n```\r\n\r\n## \ud83d\udee0\ufe0f Installation\r\n\r\n### Basic Installation\r\n```bash\r\npip install code2flow-visualizer\r\n```\r\n\r\n### Development Installation\r\n```bash\r\npip install code2flow-visualizer[dev]\r\n```\r\n\r\n### With Mermaid Support\r\n```bash\r\npip install code2flow-visualizer[mermaid]\r\n```\r\n\r\n## \ud83d\udcd6 Documentation\r\n\r\n- [Getting Started Guide](docs/getting_started.md)\r\n- [API Reference](docs/api_reference.md)\r\n- [Examples](examples/)\r\n- [Contributing](CONTRIBUTING.md)\r\n\r\n## \ud83c\udfaf Why Code2Flow Visualizer?\r\n\r\nTraditional debugging tools show you *where* your code fails, but Code2Flow Visualizer shows you *how* your code behaves. Perfect for:\r\n\r\n- Understanding complex algorithms\r\n- Teaching programming concepts  \r\n- Debugging recursive functions\r\n- Visualizing data flow in applications\r\n- Code reviews and documentation\r\n\r\n## \ud83d\udcca Example Output\r\n\r\n```\r\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\r\n\u2502 fibonacci(5)    \u2502\r\n\u2502 n = 5          \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\r\n      \u2502\r\n      \u25bc\r\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\r\n\u2502 n > 1 ?        \u2502\r\n\u2502 True           \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\r\n      \u2502\r\n      \u25bc\r\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\r\n\u2502 fibonacci(4) +  \u2502\r\n\u2502 fibonacci(3)    \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\r\n```\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\r\n\r\n## \ud83d\udcc4 License\r\n\r\nMIT License - see [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83d\ude4b\u200d\u2642\ufe0f Support\r\n\r\n- \ud83d\udc1b [Report bugs](https://github.com/Aryan0854/code2flow-visualizer/issues)\r\n- \ud83d\udca1 [Request features](https://github.com/Aryan0854/code2flow-visualizer/issues)\r\n- \ud83d\udcac [Join discussions](https://github.com/Aryan0854/code2flow-visualizer/discussions)\r\n\r\n---\r\n\r\nMade with \u2764\ufe0f for the Python community\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Real-Time Code Execution Visualizer for Python",
    "version": "0.8.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/Aryan0854/code2flow-visualizer/issues",
        "Documentation": "https://github.com/Aryan0854/code2flow-visualizer#readme",
        "Homepage": "https://github.com/Aryan0854/code2flow-visualizer",
        "Repository": "https://github.com/Aryan0854/code2flow-visualizer"
    },
    "split_keywords": [
        "debugging",
        "visualization",
        "flowchart",
        "code-analysis"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "df65ef189611bb159932a8d6dfbc0491dfce199b2ed0ad3d3150a95561d0087c",
                "md5": "a2188bb2b8b583d40a590da4fcc8e849",
                "sha256": "9f47e1270bcd22a89e467455d6db1589d567218e94e3924da03b2963dbf4a654"
            },
            "downloads": -1,
            "filename": "code2flow_visualizer-0.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a2188bb2b8b583d40a590da4fcc8e849",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 25929,
            "upload_time": "2025-08-06T19:30:53",
            "upload_time_iso_8601": "2025-08-06T19:30:53.152288Z",
            "url": "https://files.pythonhosted.org/packages/df/65/ef189611bb159932a8d6dfbc0491dfce199b2ed0ad3d3150a95561d0087c/code2flow_visualizer-0.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d9affbdf7e38c2e774b5e79ebe53934d7071acd69b669ee21aa50e06e509ef2b",
                "md5": "25e54624b4c8614d1a106e1cef32f644",
                "sha256": "d23f838852d10dfb923a47ad71f4a974b7ac507779bc5b3b75988468a657681f"
            },
            "downloads": -1,
            "filename": "code2flow_visualizer-0.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "25e54624b4c8614d1a106e1cef32f644",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 42842,
            "upload_time": "2025-08-06T19:30:54",
            "upload_time_iso_8601": "2025-08-06T19:30:54.453836Z",
            "url": "https://files.pythonhosted.org/packages/d9/af/fbdf7e38c2e774b5e79ebe53934d7071acd69b669ee21aa50e06e509ef2b/code2flow_visualizer-0.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-06 19:30:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Aryan0854",
    "github_project": "code2flow-visualizer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "code2flow-visualizer"
}
        
Elapsed time: 4.25704s