Skip to content

PRD.md

Latest commit

 

History

History
17 lines (13 loc) · 1.33 KB

PRD.md

File metadata and controls

17 lines (13 loc) · 1.33 KB
Raw

Product Requirements Document (PRD) - CodeGraph

1. Objective

CodeGraph is an advanced developer tool designed to eliminate the friction of understanding complex, legacy, or unfamiliar Python codebases. It transforms raw source code directories into interactive, node-based relational dependency graphs, enabling engineers to visually trace function calls, class inheritances, and modular dependencies.

2. Target User

  • Backend Engineers, Code Reviewers, and Architects onboarding onto multi-file codebases who need immediate structural clarity without manually tracing execution paths.

3. Minimum Viable Product (MVP) Scope

  • Code Ingestion: Secure multi-file or single-file code uploads.
  • AST Processing Engine: Asynchronous parsing of source code into Abstract Syntax Trees (AST) to identify Classes, Functions, and their internal calls/imports.
  • Relational Mapping: Conversion of parsed AST metrics into standardized Node and Edge JSON definitions.
  • Interactive Visualization UI: High-fidelity, zoomable, draggable node-graph explorer interface.

4. Non-Functional Requirements

  • Asynchronous Isolation: Heavy parsing workloads must never block the client-facing HTTP thread.
  • Ephemeral Processing: Uploaded files are immediately processed and deleted; only the structural graph metadata persists in storage.