https://github.com/zaibon/gitsumbot

GitSumBot is a package that generates a summary of changes made to a codebase using commit messages
https://github.com/zaibon/gitsumbot

ai git go gpt-3

Last synced: 2 months ago
JSON representation

GitSumBot is a package that generates a summary of changes made to a codebase using commit messages

• Host: GitHub
• URL: https://github.com/zaibon/gitsumbot
• Owner: zaibon
• License: mit
• Created: 2023-03-17T17:51:55.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-02-24T09:54:32.000Z (4 months ago)
• Last Synced: 2026-02-24T15:40:27.355Z (4 months ago)
• Topics: ai, git, go, gpt-3
• Language: Go
• Homepage:
• Size: 177 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# ![assets/logo.png](assets/logo.png) GitSumBot 

GitSumBot is a Go program that generates a summary of changes made to a codebase using commit messages.

## Installation

To install GitSumBot, you need to have Go 1.16 or later installed on your system. You can then install GitSumBot by running:

```shell

go get github.com/zaibon/gitsumbot

```

## Usage

### API

GitSumBot provides an API that you can use to generate summaries of code changes programmatically. To use the API, you need to import the gitsumbot package and create a new instance of the GitSumBot struct:

```go

import "github.com/sashabaranov/gitsumbot"

func main() {

    var(

        githubOwner       ="zaibon"

        githubRepo        ="gitsumbot"

        githubAccessToken = "..." // Github token with scope to read the repository you want to summarize

        openAIAccessToken = "..." // openAI API token

        modelVersion      = gitsumbot.ModelVersionGPT4

    )

    bot := gitsumbot.New(githubAccessToken, openAIAccessToken, modelVersion)

    changeDigest, err := bot.ChangeDigest(ctx, githubOwner, githubRepo, time.Hour * 24 * 7)

    if err != nil {

        log.Fatalf("error while generating summary: %v", err)

    }

    fmt.Println(changeDigest.Summary)

    fmt.Println(changeDigest.Categorized)

}

```

## Fun fact

This AI assistant has named itself. Here is the reasoning behind the name.

`It's a pun on "get some bot", which implies that the AI is helping you get a summary of the code changes you need. Plus, "Git" is a reference to the popular version control system used by developers.`