Rugburn

Software Development

Effortlessly Create GitHub READMEs with GPT-4

This project generates README files from GitHub repositories using GPT-4o-Mini. By inputting the repository owner’s name and repo name, the tool fetches relevant files and creates a formatted README in Markdown. Key skills include using GitHub API, OpenAI API calls, and LLM Engineering for structured data responses.

Overview

This projects is designed to take a Github Repo Owner, and Repo Name as input (i.e. “RugburnDev”,“Snow-Surfer”), and make two engineered calls to GPT-4o-Mini, first parsing which repo filenames may be useful in the generation of a README file, then actually reading those files to generate a README file, formatted in Markdown.

Skills

  • Github API to get and parse relevant files from a repo
  • OpenAI API with calls to openai.chat.completions
  • LLM Engineering use of system prompts, and user prompts

Check out the Code

Open

See the source code

More pROJECTS