https://github.com/ali-rajabpour/fileflow
FileFlow generates a visual diagram and Markdown report of file-to-file import dependencies within a Python project using only the standard library.
https://github.com/ali-rajabpour/fileflow
code-analysis codebase-management dependencies dependency-verification dependency-viewer dependency-visualizer documentation-tool import-graph markdown md project-architecture python python3 static-analysis
Last synced: 14 days ago
JSON representation
FileFlow generates a visual diagram and Markdown report of file-to-file import dependencies within a Python project using only the standard library.
- Host: GitHub
- URL: https://github.com/ali-rajabpour/fileflow
- Owner: ali-rajabpour
- Created: 2025-04-20T06:48:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-20T06:56:55.000Z (about 1 year ago)
- Last Synced: 2025-04-20T07:42:24.210Z (about 1 year ago)
- Topics: code-analysis, codebase-management, dependencies, dependency-verification, dependency-viewer, dependency-visualizer, documentation-tool, import-graph, markdown, md, project-architecture, python, python3, static-analysis
- Language: Python
- Homepage: https://Rajabpour.com
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FileFlow: Python Import Dependency Visualizer
FileFlow analyzes a Python project directory and generates a visual diagram illustrating the relationships between `.py` files based on their import statements. The diagram maps which files import others and displays these dependencies as a directed graph.
## Features
- **Recursive Analysis**: Scans all `.py` files in the project, including nested directories.
- **File-to-File Import Mapping**: Focuses on file-level import relationships (not class/function calls).
- **Markdown Output**: Outputs a Markdown file listing all file-to-file import relationships.
- **Efficient**: Designed to handle large codebases efficiently.
## Requirements
- Python 3.7+
- No external dependencies. FileFlow uses only the Python standard library.
You do not need to install any additional packages.
## Usage
From the project directory, run:
```
python FileFlow.py
```
- ``: Root directory of the Python project you want to analyze.
- `--output`: (optional) Output Markdown file path. Default is `fileflow_output.md`.
Example:
```
python FileFlow.py ./myproject --output my_report.md
```
The resulting Markdown report will be saved to the specified file. It lists all file-to-file import relationships in your project.
## Notes
- Only imports between files within the specified project directory are shown as edges.
- External library imports are ignored.
- If a file contains syntax errors, it will be skipped.
## License
MIT License