RepoMap - Python Repository Intelligence & Codebase Analysis Platform

RepoMap is a beginner-friendly tool that helps you understand how a Python project works.

When developers open an unfamiliar project, it can be difficult to know:

- Which file should be opened first
- Where the application starts
- Which files are most important
- How files depend on each other
- What the project configuration files do
- How the main parts of the project are connected

RepoMap solves this problem by creating a visual and written map of the repository.

A user provides a public GitHub or Git repository URL. RepoMap temporarily downloads the repository and examines its Python files without running or executing the project code. It identifies important files, detects relationships between modules, finds possible entry points, and calculates which modules are used most often.

The application then displays the results in an easy-to-understand dashboard. Users can view an architecture summary, a recommended reading order, a list of important modules, and an interactive dependency graph.

RepoMap can optionally use the Groq AI API to create clearer explanations and summaries. The AI receives only limited repository evidence prepared by RepoMap. If AI is unavailable, the application still creates a local guide using its own analysis.

Users can create an account and securely access their own analysis history. Analysis results are stored in a local SQLite database, allowing users to reopen previous reports later. Reports can also be downloaded as PDF files for sharing, documentation, or offline reading.

RepoMap is useful for:

- Beginners learning an existing Python project
- Developers joining a new team
- Students studying open-source repositories
- Reviewers exploring project architecture
- Teams creating onboarding documentation
- Anyone who wants to understand a codebase before modifying it

The project runs locally without Docker or PostgreSQL and includes both a web interface and a command-line tool.

1. Create an account or sign in.
2. Enter a public HTTPS Git repository URL.
3. Start the repository analysis.
4. Review the architecture overview.
5. Explore the recommended reading order.
6. Browse ranked Python modules.
7. Inspect the interactive dependency graph.
8. View important project files and summaries.
9. Reopen previous analyses from history.
10. Download the analysis as a PDF report.
11. Use the CLI to analyze a local Git repository.

Python 3.12 or newer
Node.js
npm
Git
FastAPI
Uvicorn
A public HTTPS Git repository URL
Optional Groq API key
Windows, macOS, or Linux
Internet connection for cloning public repositories
Internet connection for optional Groq AI enrichment