https://github.com/charconstpointer/sammy

Github activity summarizer
https://github.com/charconstpointer/sammy

activity github gpt-3

Last synced: about 22 hours ago
JSON representation

Github activity summarizer

• Host: GitHub
• URL: https://github.com/charconstpointer/sammy
• Owner: charconstpointer
• Created: 2023-02-01T12:51:46.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-06T18:02:35.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T19:55:13.804Z (5 months ago)
• Topics: activity, github, gpt-3
• Language: Go
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# README.md for Sammy

## Overview

Sammy is a program that generates a report from a GitHub user's activity using OpenAI's GPT-3 language model. 

## Usage

`OPEN_AI_TOKEN=token GITHUB_TOKEN=token sammy -user= -max_tokens= -public= -from= -to=`

## Flags

`-user`: Specifies the GitHub username of the user for whom the report is generated.

`-max_tokens`: Specifies the maximum number of tokens to be used by the GPT-3 model in the report.

`-public`: Specifies whether the report should be publicly accessible or not. Set to `true` for public access and `false` for private access.

`-from`: Specifies the start date for the report, in the format of RFC3339.

`-to`: Specifies the end date for the report, in the format of RFC3339.

## Example

`OPEN_AI_TOKEN=token GITHUB_TOKEN=token sammy -user=foo -max_tokens=100 -public=true -from="2022-01-01T00:00:00Z" -to="2022-12-31T23:59:59Z"`

This command generates a summary of the GitHub user foo activity between January 1, 2022 and December 31, 2022, using a maximum of 100 tokens from the GPT-3 model and only including public events.

## Note

Please make sure to have the necessary permissions and access to generate the report, as well as sufficient tokens for the GPT-3 model and GitHub API, before running the program.

You might need to tweak `-max_tokens` if your report happens to be a lengthy one and gets only partially generated

If time range is not provided it will default to last 24 hours