Skip to content

greptileai/repo-summarizer-py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Repo Summarizer (Python Version)

A CLI tool to summarize files in a directory using OpenAI.

Installation

cd repo-summarizer-py
pip install -r requirements.txt
pip install -e .

Usage

repo-summarizer -d /path/to/directory -k your_openai_api_key

Options

  • -d, --directory (required): Directory to process
  • -o, --output: Output JSON file path
  • -k, --api-key: OpenAI API key (or set OPENAI_API_KEY env var)
  • -l, --log-level: Log level (debug, info, warn, error) [default: info]
  • -m, --model: OpenAI model to use [default: gpt-3.5-turbo]

Environment Variables

You can set the OpenAI API key as an environment variable:

export OPENAI_API_KEY="your_api_key_here"
repo-summarizer -d /path/to/directory

Example

# Summarize files and output to console
repo-summarizer -d ./test-files -k sk-your-api-key

# Summarize files and save to JSON file
repo-summarizer -d ./test-files -o summary.json -k sk-your-api-key

# Use environment variable for API key
export OPENAI_API_KEY="sk-your-api-key"
repo-summarizer -d ./test-files -o summary.json

Features

  • Processes text files in a directory
  • Generates AI-powered summaries using OpenAI
  • Supports multiple file formats (js, ts, py, md, txt, etc.)
  • JSON output with file metadata
  • Configurable logging levels
  • Error handling and connection testing

Requirements

  • Python 3.8+
  • OpenAI API key
  • Internet connection

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published