CodeFlowMapper is an open-source tool that generates 3D visualizations of Python codebases, helping developers quickly understand and navigate complex projects.
- 3D Visualization: Generate interactive 3D maps of your Python codebase.
- File and Function Mapping: View files as parent nodes and functions as child nodes.
- Customizable Omissions: Exclude specific directories from visualization.
- Obsidian-like Interface: Familiar and intuitive visualization style.
To run CodeFlowMapper, you can use the following command-line interface:
- Clone the repository and navigate to the project directory:
$ git clone https://github.com/Vishal-Padia/CodeFlowMapper
$ cd CodeFlowMapper- Create a virtual environment using the following command:
$ python3 -m venv venv- Activate the virtual environment:
$ source venv/bin/activate- Install the required dependencies:
$ pip install -r requirements.txt- Run the CodeFlowMapper script:
$ python main.py-
Follow the prompts to input your project path and exclude directories.
-
Access the visualization at
http://localhost:5000.
It takes some time to generate the visualization, so please be patient. HAPPY VISUALIZING!
After launching, CodeFlowMapper will:
- Download necessary models (first-time only).
- Prompt for the path to your Python file or directory.
- Ask for directories to exclude from the visualization.
- Start a Flask server and generate the 3D visualization.
- Python files and directories only
- Basic Python feature support (no decorators or lambdas)
- Static analysis only
- Add support for more programming languages
- Enhance visualization with more features
- Complex Python feature support
- AI-Powered Code Analysis
We welcome contributions to CodeFlowMapper! If you have suggestions for improvements or bug fixes, please feel free to:
- Fork the repository
- Create a new branch
(git checkout -b feature/AmazingFeature) - Commit your changes
(git commit -m 'Add some AmazingFeature') - Push to the branch
(git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
Vishal Padia - [email protected]
Project Link: https://github.com/Vishal-Padia/CodeFlowMapper