readmeai 0.3.35

🚀 Generate beautiful README.md files. Powered by OpenAI's GPT language model APIs 💫

README-AI

◦ Generate beautiful and informative README.md files.

◦ Developed with OpenAI's GPT language model APIs.

---

📖 Table of Contents

• 📖 Table of Contents
• 📍 Overview
• 🤖 Demo
• 🕹 Play
• ✨ Features
• 🚀 Getting Started
  • 📋 Dependencies
    • 📂 Repository
    • 🔐 OpenAI API
  • 📦 Install
  • 👩‍💻 Usage
    • 🔡 Command-Line Arguments
    • 🔢 Configuration
  • 🪄 Running README-AI
  • 🧪 Running Tests
• 🛣 Roadmap
• 📒 Changelog
• 🤝 Contributing
• 📄 License
• 👏 Acknowledgments

---

📍 Overview

README-AI is a powerful command-line tool that generates robust README.md files for your software and data projects. By simply providing a remote repository URL or path to your codebase, this tool auto-generates documentation for your entire project, leveraging the capabilities OpenAI's GPT language model APIs. README-AI is currently available as a Python library and Docker image.

🎯 Motivation

README-AI simplifies the process of writing and maintaining high-quality project documentation, enhancing developer productivity and workflow. The ultimate goal of readme-ai is to improve the adoption and usability of open-source software, enabling all skill levels to better understand complex codebases and easily use open-source tools.

⚠️ Disclaimer

This project is currently under development and has an opinionated configuration. While readme-ai 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.

---

🤖 Demo

🕹 Play

Explore readme-ai in directly in browser with Streamlit Community Cloud. No installation required!

• Try readme-ai on streamlit

---

✨ 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!

	Example File	Repository	Language	Bytes
1️⃣	readme-python.md	readme-ai	Python	19,839
2️⃣	readme-typescript.md	chatgpt-app-react-typescript	TypeScript, React	988
3️⃣	readme-javascript.md	assistant-chat-gpt-javascript	JavaScript, React	212
4️⃣	readme-kotlin.md	file.io-android-client	Kotlin, Java, Android	113,649
5️⃣	readme-rust-c.md	rust-c-app	C, Rust	72
6️⃣	readme-go.md	go-docker-app	Go	41
7️⃣	readme-java.md	java-minimal-todo	Java	17,725
8️⃣	readme-fastapi-redis.md	async-ml-inference	Python, FastAPI, Redis	355
9️⃣	readme-mlops.md	mlops-course	Python, Jupyter	8,524
🔟	readme-pyflink.md	flink-flow	PyFlink	32

⒏
👇

📜 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

Please ensure you have the following dependencies installed on your system:

• Python version 3.9 or higher
• Package manager (i.e. pip, conda, poetry) or Docker
• OpenAI API paid account and api key

📂 Repository

A remote repository URL or path to your local project's directory is needed to use readme-ai. The following repository types are currently supported:

• GitHub
• GitLab
• File System

🔐 OpenAI API

An OpenAI API account and API key are needed to use readme-ai. The steps below outline this process:

OpenAI API - User Guide

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.

⚠️ OpenAI API - Important Notes

• Ensure all content in your repository is free of sensitive information before executing readme-ai.
• The OpenAI API is NOT free and you will be charged for each request made, which can accumulate costs rapidly.
  • Regularly monitor your API usage and costs by visiting the OpenAI API Usage Dashboard.
  • Also ensure your OpenAI account has sufficient credits to run the readme-ai application.
• Setting up an OpenAI API payment account is recommended to avoid API usage restrictions.
  • Without a payment method, API usage will be restricted to the base gpt-3 models.
  • This often leads to inaccurate README file generation and errors due to API request limits.
• README file generation should take under 1 minute. Terminate readme-ai if runtime exceeds more than a few minutes (i.e. 3 minutes).

---

📦 Install

Using Pip

Pip is the recommended installation method for most users. More details about the Python package can be found on PyPI.

pip install --upgrade readmeai

Using Docker

Docker is recommended for users wanting to run readme-ai in a containerized environment. More details about the image can be found on Docker Hub.

docker pull zeroxeli/readme-ai:latest

Install Manually

1️⃣ Clone the readme-ai repository.

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

2️⃣ Navigate to readme-ai directory.

cd readme-ai

3️⃣ Install dependencies using a method below.

Using Bash

bash setup/setup.sh

Using Conda

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

Using Poetry

poetry install

---

👩‍💻 Usage

🔡 Command-Line Arguments

To generate a README.md file, use the readmeai command in your terminal, along with the arguments below.

Short Flag	Long Flag	Description	Status
-k	--api-key	Your OpenAI API key.	Required
-o	--output	The output path for your README.md file.	Required
-r	--repository	The URL or path to your code repository.	Required
-t	--template	The README template format to use. (coming soon!)	Coming Soon!
-l	--language	The language of text written in the README file.	Coming Soon!

🔢 Configuration

To customize the README file generation process, you can modify the configuration file. The file contains the following sections:

• api - OpenAI language model API configuration settings.
• git - Default git repository settings used if no repository is provided.
• paths - Directory paths and files used by the readme-ai application.
• prompts - Large language model prompts used to generate the README file.
• md - Dynamic Markdown section code templates used to build the README file.

---

🪄 Running README-AI

Using Streamlit Community Cloud

Use readme-ai directly in your browser with Streamlit. No installation required!

• Try readme-ai on streamlit

Using Pip

# Option 1: Run readmeai command with all required command-line arguments.
readmeai --api-key "YOUR_API_KEY" --output readme-ai.md --repository https://github.com/eli64s/readme-ai

# Option 2: Run readmeai command with OpenAI API key set as environment variable.
export OPENAI_API_KEY="YOUR_API_KEY"
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai

Using Docker

# Option 1: Run Docker container with all required command-line arguments.
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

# Option 2: Run Docker container with OpenAI API key set as environment variable.
export OPENAI_API_KEY="YOUR_API_KEY"
docker run -it \
-e OPENAI_API_KEY=$OPENAI_API_KEY \
-v "$(pwd)":/app zeroxeli/readme-ai:latest \
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai

Run Manually

Using 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

Using 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 test suite using command below.

bash scripts/test.sh

---

🛣 Roadmap

• Publish project as a Python library via PyPI and a Docker image on Docker Hub.
  • PyPI - readmeai
  • Docker Hub - readme-ai
• Integrate and deploy app with Streamlit to provide a simple user-interface for using the tool.
  • Streamlit Community Cloud - readmeai
• Develop GitHub Actions script to automatically update the README file when new code is pushed.
• Design README output templates for a variety of use-cases (i.e. data, web-dev, minimal, etc.)
• Add support for generating README files in any language (i.e. CN, ES, FR, JA, KO, RU).

---

📒 Changelog

Changelog

---

🤝 Contributing

Contributing Guidelines

---

📄 License

MIT

---

👏 Acknowledgments

Badges

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

🔝 Return

---