README.md

metadata

title: Github Repo Visualizer
emoji: 🌍
colorFrom: purple
colorTo: pink
sdk: gradio
sdk_version: 4.44.0
app_file: app.py
pinned: false
license: apache-2.0

Github Repo Visualizer 🌍

Github Repo Visualizer is a tool to visualize GitHub repositories using Gradio.

Table of Contents

• Github Repo Visualizer 🌍
  • Table of Contents
  • Installation
  • Usage
• App Flow

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/Github-Repo-Visualizer.git
   cd Github-Repo-Visualizer
   

2. Install the required dependencies:

   pip install -r requirements.txt
   

Usage

To run the application, execute:

python app.py

App Flow

graph TD
    A[Input Repo] --Get Repo Info--> B[Load Repo]
    B --Plan a exploration strategy--> C[planner]
    C --Explore files based on graph--> D[explore_file]
    D --Summarize dependencies and functionalities--> E[get_file_content_summary]
    E --Build undersrtanding and generte graph--> F[generate_mermaid_code]
    F --Fix errors and render--> G[render_mermaid]

• Please visit prompt.py to see the different prompts used for each functionality.
• Please note that the exploration is capped to top 25 files based on the plan.
• utils.py contains all the nodes and edge functions used in the graph.
• app.py contains the main code for graph compilation and run.