readme ai

README-AI, Your AI-Powered Documentation Assistant

Designed for simplicity, customization, and developer productivity.

🔗 Quick Links

1. ⚡️ Introduction
2. 👾 Demo
3. ☄️ Features
4. 🛸 Quickstart
5. 🔡 Configuration
6. 🤖 Examples
7. 🔰 Contributing

[!IMPORTANT]
✨ See the Official Documentation for more details.

⚡️ Introduction

Objective

README-AI is a developer tool for automatically generating README markdown files using a robust repository processor engine and generative AI. Simply provide a repository URL or local path to your codebase, and a well-structured and detailed README file will be generated for you.

Motivation

This project aims to streamline the documentation process for developers, ensuring projects are properly documented and easy to understand. Whether you’re working on an open-source project, enterprise software, or a personal project, README-AI is here to help you create high-quality documentation quickly and efficiently.

👾 Demo

Running from the command line:

readmeai-cli-demo

Running directly in your browser:

readmeai-streamlit-demo

☄️ Features

• Automated Documentation: Synchronize data from third-party sources and generates documentation automatically.
• Customizable Output: Dozens of options for styling/formatting, badges, header designs, and more.
• Language Agnostic: Works across a wide range of programming languages and project types.
• Multi-LLM Support: Compatible with OpenAI, Ollama, Anthropic, Google Gemini and Offline Mode.
• Offline Mode: Generate a boilerplate README without calling an external API.
• Markdown Best Practices: Leverage best practices in Markdown formatting for clean, professional-looking docs.

A few combinations of README styles and configurations:

--image custom --badge-color FF4B4B --badge-style flat-square --header-style classic
--image cloud --header-style compact --toc-style fold
--align left --badge-style flat-square --image cloud	--align left --badge-style flat --image gradient
--badge-style flat --image custom	--badge-style skills-light --image grey
--badge-style flat-square	--badge-style flat --image black
--image custom --badge-color 00ffe9 --badge-style flat-square --header-style classic
--image llm --badge-style plastic --header-style classic
--image custom --badge-color BA0098 --badge-style flat-square --header-style modern --toc-style fold

See the Configuration section for a complete list of CLI options.

📍 Overview

Overview ◎ High-level introduction of the project, focused on the value proposition and use-cases, rather than technical aspects.

✨ Features

Features Table ◎ Generated markdown table that highlights the key technical features and components of the codebase. This table is generated using a structured prompt template.

📃 Codebase Documentation

Directory Tree ◎ The project's directory structure is generated using pure Python and embedded in the README. See readmeai.generators.tree. for more details.

File Summaries ◎ Summarizes key modules of the project, which are also used as context for downstream prompts.

🚀 Quickstart Instructions

Getting Started Guides ◎ Prerequisites and system requirements are extracted from the codebase during preprocessing. The parsers handles the majority of this logic currently.

Installation Guide ◎ Installation, Usage, and Testing guides are generated based on the project's dependency files and codebase configuration.

🔰 Contributing Guidelines

Contributing Guide ◎ Dropdown section that outlines general process for contributing to your project. ◎ Provides links to your contributing guidelines, issues page, and more resources. ◎ Graph of contributors is also included.

Additional Sections ◎ Project Roadmap, Contributing Guidelines, License, and Acknowledgements are included by default.

🛸 Getting Started

System Requirements:

• Python 3.9+
• Package Manager/Container: pip, pipx, docker
• LLM API Service: OpenAI, Ollama, Anthropic, Google Gemini, Offline Mode

Repository URL or Path:

Make sure to have a repository URL or local directory path ready for the CLI.

• GitHub
• GitLab
• Bitbucket
• File System

LLM API Service:

• OpenAI: Recommended, requires an account setup and API key.
• Ollama: Free and open-source, potentially slower and more resource-intensive.
• Anthropic: Requires an Anthropic account and API key.
• Google Gemini: Requires a Google Cloud account and API key.
• Offline Mode: Generates a boilerplate README without making API calls.

🔩 Installation

Install readme-ai using your preferred package manager, container, or directly from the source.

Using pip

❯ pip install readmeai

Using pipx

❯ pipx install readmeai

[! TIP]

_{Use pipx to install and run Python command-line applications without causing dependency conflicts with other packages!}

Using docker

Pull the latest Docker image from the Docker Hub repository.

❯ docker pull zeroxeli/readme-ai:latest

From source

❯ bash setup/setup.sh

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

❯ cd readme-ai

❯ poetry install

❯ poetry shell

Installing Optional Dependencies

To use the Anthropic and Google Gemini clients, install the optional dependencies.

Anthropic:

❯ pip install readmeai[anthropic]

Google Gemini:

❯ pip install readmeai[gemini]

⚙️ Usage

Environment Variables

OpenAI

Generate a OpenAI API key and set it as the environment variable OPENAI_API_KEY .

# Using Linux or macOS
❯ export OPENAI_API_KEY=<your_api_key>

# Using Windows
❯ set OPENAI_API_KEY=<your_api_key>

Ollama

Pull your model of choice from the Ollama repository:

❯ ollama pull mistral:latest

Start the Ollama server:

❯ export OLLAMA_HOST=127.0.0.1 && ollama serve

_{See all available models from Ollama here.}

Anthropic

Generate an Anthropic API key and set the following environment variables:

❯ export ANTHROPIC_API_KEY=<your_api_key>

Google Gemini

Generate a Google API key and set the following environment variables:

❯ export GOOGLE_API_KEY=<your_api_key>

Running the CLI

Using pip

With OpenAI:

❯ readmeai --api openai --repository https://github.com/eli64s/readme-ai

[! IMPORTANT]
By default, the gpt-3.5-turbo model is used. Higher costs may be incurred when more advanced models.

With Ollama:

❯ readmeai --api ollama --model llama3 --repository https://github.com/eli64s/readme-ai

With Anthropic:

❯ readmeai --api anthropic -m claude-3-5-sonnet-20240620 -r https://github.com/eli64s/readme-ai

With Gemini:

❯ readmeai --api gemini -m gemini-1.5-flash -r https://github.com/eli64s/readme-ai

Adding more customization options:

❯ readmeai --repository https://github.com/eli64s/readme-ai \
           --output readmeai.md \
           --api openai \
           --model gpt-4 \
           --badge-color A931EC \
           --badge-style flat-square \
           --header-style compact \
           --toc-style fold \
           --temperature 0.9 \
           --tree-depth 2
           --image LLM \
           --emojis

Using docker

Running the Docker container with the OpenAI API:

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

Using streamlit

Try readme-ai directly in your browser, no installation required. See the readme-ai-streamlit repository for more details.

From source

  ❯ conda activate readmeai
  ❯ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai

  ❯ poetry shell
  ❯ poetry run python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai

🧪 Testing

The pytest framework and nox automation tool are used for testing the application.

Using pytest

❯ make test

Using nox

❯ make test-nox

[!TIP]
_{Use nox to test application against multiple Python environments and dependencies!}

🔡 Configuration

Customize your README generation using these CLI options:

[!TIP]
For a full list of options, run readmeai --help in your terminal.

🎨 Customization

To see the full list of customization options, check out the Configuration section in the official documentation. This section provides a detailed overview of all available CLI options and how to use them, including badge styles, header templates, and more.

🤖 Examples

_{See additional README files generated by readme-ai here}

🏎💨 Project Roadmap

• [ ] Release readmeai 1.0.0 with enhanced documentation management features.
• [ ] Develop Vscode Extension to generate README files directly in the editor.
• [ ] Develop GitHub Actions to automate documentation updates.
• [ ] Add badge packs to provide additional badge styles and options.
  • [ ] Code coverage, CI/CD status, project version, and more.

🔰 Contributing

Contributions are welcome and encouraged! If interested, please begin by reviewing the resources below:

• 💡 Contributing Guide: Learn about our contribution process, coding standards, and how to submit your ideas.
• 💬 Start a Discussion: Have questions or suggestions? Join our community discussions to share your thoughts and engage with others.
• 🐛 Report an Issue: Found a bug or have a feature request? Let us know by opening an issue so we can address it promptly.

📒 Changelog

Changelog

🎗 License

MIT License

🙌 Acknowledgments

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

⬆️ Top