README-AI

◦ Generate beautiful and informative README.md documents.

◦ Developed with OpenAI's GPT language model APIs.

📖 Table of Contents

• 📖 Table of Contents
• 📍 Overview
  • 🎯 Motivation
  • ⚠️ Disclaimer
• 👾 Demo
• ⚙️ Features
• 🚀 Getting Started
  • ✔️ Dependencies
    • 📂 Repository
    • 🔐 OpenAI API
  • 📦 Installation
  • 🎮 Using README-AI
  • 🧪 Running Tests
• 🛠 Future Development
• 📒 Changelog
• 🤝 Contributing
• 📄 License
• 👏 Acknowledgments

📍 Overview

README-AI is a powerful, user-friendly command-line tool that generates extensive README markdown documents for your software and data projects. By providing a remote repository URL or path to your codebase, this tool generates documentation for your entire project, leveraging the capabilities of large language models and OpenAI's GPT APIs.

🎯 Motivation

Simplifies the process of writing and maintaining high-quality project documentation. My aim for this project is to provide all skill levels a tool that improves their technical workflow, in an efficient and user-friendly manner. Ultimately, the goal of README-AI is to improve the adoption and usability of open-source projects, enabling everyone to better understand and use open-source tools.

⚠️ Disclaimer

README-AI is currently under development and has an opinionated configuration and setup. While this tool provides an excellent starting point for documentation, its important to review all text generated by the OpenAI API to ensure it accurately represents your codebase. Ensure all content in your repository is free of sensitive information before executing.

Additionally, frequently monitor your API usage and costs by visiting the OpenAI API Usage Dashboard.

👾 Demo

⚙️ Features

1.
👇

📑 Codebase Documentation

◦ Repository File Summaries Code summaries are generated for each file via OpenAI's gpt-3.5-turbo engine. The File column in the markdown table contains a link to the file on GitHub.

⒉
👇

🎖 Badges

◦ Introduction, Badges, & Table of Contents The OpenAI API is prompted to create a 1-sentence phrase describing your project. Project dependencies and metadata are visualized using Shields.io badges. Badges are sorted by hex code, displayed from light to dark hues.

⒊
👇

🧚 Prompted Text Generation

◦ Features Table & Overview Detailed prompts are embedded with repository metadata and passed to the OpenAI API. Features table highlights various technical attributes of your codebase. Overview section describes your project's use case and applications.

⒋
👇

🌲 Repository Tree

⒌
👇

📦 Dynamic User Setup Guides

◦ Installation, Usage, & Testing Generates instructions for installing, using, and testing your codebase. README-AI currently supports this feature for code written with: Python, Rust, Go, C, Kotlin, Java, JavaScript, TypeScript.

⒍
👇

👩‍💻 Contributing Guidelines & more!

⒎
👇

💥 Example README Files

Example markdown files generated by readme-ai!

⒏
👇

📜 Custom README templates coming soon!

Developing a feature that allows users to select from a variety of README formats and styles.

Custom templates will be tailored for use-cases such as data, ai & ml, research, minimal, and more!

🔝 Return

🚀 Getting Started

✔️ Dependencies

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

• Python 3.9, 3.10, 3.11
• Pip, Poetry, Conda, or Docker (see installation methods below)
• OpenAI API account and api key (see setup instructions below)

📂 Repository

Most user's will run README-AI using the command-line, specifying their repository on run-time. However, if you would like to use the default configuration, you will need to update the configuration file with your repository's remote URL or a local path to your codebase.

[git]
repository = "Insert your repository URL or local path here!"

🔐 OpenAI API

To use the README-AI app, you must create an OpenAI API account and generate an API key. The steps below outline this process:

⚠️ Note

• To maximize your experience with README-AI, it is recommended to set up a payment method on OpenAI's website. By doing so, you gain access to more powerful language models like gpt-3.5-turbo. Without a payment method, your usage will be restricted to the base gpt-3 models. This limitation might lead to less precise README files or potential errors during the generation process.

• When using a payment method, make sure you have sufficient credits to run the README-AI application. Additionally, remember to regularly monitor your API usage and costs by visiting the OpenAI API Usage Dashboard. Please note that this API is not free and you will be charged for each request made, which can accumulate rapidly.

• The generation of the README.md file should typically complete in under 1 minute. If it takes longer than a few minutes, please terminate the process.

📦 Installation

Use any of the following methods to install project dependencies.

Pip (PyPI Package)

pip install --upgrade readmeai

Docker (Docker Hub)

docker pull zeroxeli/readme-ai:latest

If you prefer to install the project dependencies locally, follow the steps below.

1. Clone the readme-ai repository to your machine.

git clone https://github.com/eli64s/readme-ai

2. Navigate to the readme-ai directory.

cd readme-ai

3. Install the project dependencies using one of the following methods.

Bash

bash setup/setup.sh

Conda

conda create -n readmeai python=3.9 -y && \
conda activate readmeai && \
pip install -r requirements.txt

Poetry

poetry install

🎮 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. You can also provide the output path in the configuration file

Command-Line Arguments:

• -k or --api-key: Your OpenAI API key.
• -o or --output: The output path for your README.md file.
• -r or --repository: The URL or path to your code repository.
• -t or --template: The README template format to use. (coming soon!)
• l or --language: The language of text written in the README file (coming soon!)

Use any of the following methods to run the readme-ai CLI application.

Pip (PyPI Package)

readmeai --api-key "YOUR_API_KEY" --output readme-ai.md --repository https://github.com/eli64s/readme-ai

# Or export your OpenAI API key as an environment variable
export OPENAI_API_KEY="YOUR_API_KEY"
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai

Docker (Docker Hub)

docker run -it \
-e OPENAI_API_KEY="YOUR_API_KEY" \
-v "$(pwd)":/app zeroxeli/readme-ai:latest \
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai

Conda

conda activate readmeai
export OPENAI_API_KEY="YOUR_API_KEY"
python readmeai/main.py -o readme-ai.md -r https://github.com/eli64s/readme-ai

Poetry

poetry shell
export OPENAI_API_KEY="YOUR_API_KEY"
poetry run python readmeai/main.py -o readme-ai.md -r https://github.com/eli64s/readme-ai

🧪 Running Tests

Execute the following command to run the test suite.

bash scripts/test.sh

🔝 Return

🛠 Future Development

• Distribute the readme-ai app as a Python library via PyPI and on Docker Hub.
• Integrate readme-ai with streamlit to provide a user-friendly UI for generating README files.
• Design and implement a variety of README template formats for different use-cases.
• Add support for generating README files in any language (i.e. CN, ES, FR, JA, KO, RU).
• Add GitHub Actions workflow to automatically update the README file on repository updates.

📒 Changelog

Changelog

🤝 Contributing

Contributing Guidelines

📄 License

MIT

👏 Acknowledgments

Badges

• Shields.io
• Aveek-Saha/GitHub-Profile-Badges
• Ileriayo/Markdown-Badges

🔝 Return