Auto Summary

Auto Summary is a tool designed to utilize the power of GPT-based models to automatically summarize changes from commits in a project. Its primary intention is to enhance the transparency of updates for apps or programs.

Features

  • Automated Summaries: Generate concise summaries for each commit, allowing for quick overviews of changes.
  • Integration with Git: Directly analyzes commit data from your git repository.
  • GPT-powered Analysis: Uses advanced natural language processing to understand and describe changes.

Prerequisites

  • Python 3.11.4
  • Git

Installation

  1. Clone the Auto Summary repository:
git clone https://github.com/boginni/auto-summary
  1. Navigate to the Auto Summary directory:
cd AutoSummary
  1. Install the required packages:
pip install -r requirements.txt
  1. Run the application:
python auto_summary.py

Usage

After setting up, simply run the script. It will analyze the commits in the specified git repository and generate summaries for each one.

Contributing

Contributions to Auto Summary are welcome! If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcomed.

License

This project is under the MIT license.