README-AI

🚀 Generate aesthetic, structured, and informative README.md files

⚙️ Powered by OpenAI's language model API and the software below

---

📍 Table of Contents

• 📍 Table of Contents
• 🤖 Overview
• 🔮 Features
• 🚀 Getting Started
  • ✅ Dependencies
    • 📂 GitHub Repository
    • 🔐 OpenAI API Setup
  • 💻 Installation
  • 🪄 Using README-AI
  • 🧪 Running Tests
• 🛠 Future Development
• 🤝 Contributing
• 🪪 License
• 🙏 Acknowledgments

---

🤖 Overview

README-AI is a powerful, user-friendly tool that automatically generates high-quality README files for your GitHub repositories using OpenAI's language model APIs. By simply providing the path or url to your project's codebase, this tool will craft a well-structured and comprehensive README that highlights your project's features, installation steps, usage instructions, and more.

Note:

This project is currently under development and has an opinionated configuration and setup. While README-AI provides an excellent starting point for any project that requires documentation, it is important to review all text that is generated by the OpenAI API to ensure that it accurately represents your codebase.

🔝 Return

---

🔮 Features

1.
👇

🔖 Codebase Documentation

Have you ever met anyone who enjoyed writing documentation for their project? That’s why we're building this project, enjoy!

📍 Codebase Documentation Codebase documentation is generated by the OpenAI API text-davinci-003 model engine. Each file in your repo is converted to natural language, grouped by directory, and visualized in tables in your README file.

⒉
👇

🪪 Badges

OpenAI generated introduction sentence and beautiful project badges displayed in the top section of the README.

Introduction and Badges The introduction sentence is generated by text-davinci-003 and dependencies are displayed with project badges!

⒊
👇

🌲 Repository Tree

Why not a directory tree as well? Visualize your codebase structure in your README.

⒋
👇

📚 Table of Contents and Overview

Adds a table of contents, introduction, and features sections.

📍 Table of Contents, Overview, & Features Builds table of contents, overview, and features sections. The Overview summary is generated by the OpenAI model.

⒌
👇

📦 Project Setup and User Guide

Creates instructions for setting up and using your codebase. Working on a more dynamic implementation of this section!

📍 Getting Started Dynamically creates a setup guide for others can use your project! Sections include dependencies, installation, and usage, and tests. Currently works for: Python, Go, Rust, JavaScript.

⒍
👇

👩‍💻Contributing Guidelines & more!

Adds three additional sections to build out a complete README file!

⒎
👇

💥 Example Files

Markdown example files produced by the README-AI app!

	File	GitHub	Bytes
1️⃣	README_1_PY.md	readme-ai	15459624
2️⃣	README_2_PY.md	mlops-course	8698890
3️⃣	README_3_JS.md	react-web-audio	533233
4️⃣	README_4_RUST.md	rust-contacts-cli	79104
5️⃣	README_5_FastAPI.md	job-board-fastapi	75391521

🔝 Return

---

🚀 Getting Started

✅ Dependencies

Before you begin, ensure that you have the following prerequisites installed:

• Python 3.7 or higher
• Conda package manager (recommended)
• Access to the OpenAI API (see OpenAI API Setup below)

📂 GitHub Repository

Copy the url of your project's GitHub repository and update the configuration file as seen in the code snippet below. Additionally, you can provide a local path to your repository if you are not using GitHub.

[github]
local = "INSERT-LOCAL-REPO-PATH"
remote = "INSERT-GITHUB-REPO-URL"

🔐 OpenAI API Setup

To use README-AI, you will need an API key for OpenAI. Follow the steps below to create an API key:

User Guide - OpenAI API

1. Go to the OpenAI website.
2. Click the "Sign up for free" button.
3. Fill out the registration form with your information and agree to the terms of service.
4. Once logged in, click on the "API" tab.
5. Follow the instructions to create a new API key.
6. Copy the API key and keep it in a secure place.

💻 Installation

1. Clone the README-AI repository:

git clone https://github.com/eli64s/README-AI.git && cd README-AI

2. Create a Conda environment and install the required dependencies:

# With Bash
bash setup/setup.sh

# With Conda
conda env create -f setup/environment.yaml
conda activate readmeai
pip install -r requirements.txt

3. Set up the OpenAI API key by creating an environment variable:

export OPENAI_API_KEY=<your-api-key>

🪄 Using README-AI

Use the command-line to provide the OpenAI API key (if not already set) and specify an output path for your README file, along with the path to your local repository or remote code repository.

Command-Line Arguments:

• --api_key : Provide your OpenAI API key.
• --local : Provide the full path of a local repository.
• --output : Provide a path where to write the output file.
• --remote : Provide a URL of a remote GitHub repository.

python src/main.py --api_key skabc0123456789 --output docs/README.md --remote https://github.com/eli64s/readme-ai

Alternatively, run the bash script to run README-AI with the default configuration.

bash scripts/run_main.sh

🧪 Running Tests

To run the unit-tests for README-AI, use the following command.

bash scripts/test.sh

🔝 Return

---

🛠 Future Development

• Add compatibility for additional languages (current - Python, Rust, JavaScript, Go).
• Implement different configuration README format and style templates.
• Add user interface and backend with FastAPI to improve user experience.
• Add ability to choose the language of the generated README file.

---

🤝 Contributing

Contributions are welcomed and encouraged! Please follow these steps in the Contributing Guidelines, thank you!

---

🪪 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🙏 Acknowledgments

• Badge Icons: Aveek-Saha/GitHub-Profile-Badges

🔝 Return

---