RepoGPT

RepoGPT is a tool designed to summarize the code (.py) and docs (.md) files in a repository. It works iterating through directories and generating detailed and structured project summaries - including classes, functions and and the docstrings. It supports .txt or .json output files, ready for your favourite LLM to ingest!

Inspired by the gpt-repository-loader and gptrepo.

Examples

Example 1

Example 2

Installing

Clone the Repository:

git clone https://github.com/MrCabss69/RepoGPT.git

Navigate to the Project Directory

cd RepoGPT

Install the module

pip install -e .

Using RepoGPT

Once installed, you can go to the root directory of your project and exec in your terminal:

repogpt

With some customization:

repogpt --output example.json

A .json file will appear in the current working directoy, with the summary generated.

Main Features

• File Analysis: RepoGPT performs a deep scan of the files in the repository, collecting crucial information such as line count, classes and their methods, independent functions and associated docstrings.

• Documentation Improvement: The tool places special emphasis on the clarity and quality of code documentation, promoting good practices such as the use of clear nomenclatures for variables and detailed documentation strings.

Detailed Analysis Options

RepoGPT allows you to customize the analysis using the following options:

• --output: Defines the file name and extension to output in the analysis. By now .txt and .json formats are accepted. By default, 'example.txt' file are created.

Structure

├── README.md
├── repogpt
│   ├── docs
│   │   ├── IDEA.md
│   ├── __init__.py
│   └── tree_build.py
└── setup.py