- 📒 Table of Contents
- 💫 Overview
- 👾 Demo
- ⚙️ Features
- 🚀 Getting Started
- 🛠 Future Development
- 🤝 Contributing
- 📄 License
- 👏 Acknowledgments
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 directory path to your codebase, this tool will document your entire project, leveraging the capabilities of large language models and OpenAI's GPT APIs.
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.
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, regularly monitor your API usage and costs by visiting the OpenAI API Usage.
|
|
|
|
|
|
|
|
|
 |
Markdown example files generated by the README-AI app!
| 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 |
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!
Before you begin, ensure that you have the following prerequisites installed:
- Python 3.8 or higher
- Conda package manager (recommended)
- Access to the OpenAI API (see the setup guide below)
Most user's will run README-AI using the command-line interface, 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 (GitHub, GitLab) or local directory pat on your machine.
# Repository Configuration
[git]
repository = "INSERT YOUR REPOSITORY URL / LOCAL DIRECTORY"To use the README-AI application, you will need to create an account with OpenAI to generate an API key. The steps below outline this setup process:
OpenAI API User Guide
- Go to the OpenAI website.
- Click the "Sign up for free" button.
- Fill out the registration form with your information and agree to the terms of service.
- Once logged in, click on the "API" tab.
- Follow the instructions to create a new API key.
- Copy the API key and keep it in a secure place.
⚠️ 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.
- Clone the README-AI repository to your local machine.
git clone https://github.com/eli64s/README-AI- Navigate to the README-AI directory.
cd README-AI- Use one of the following methods to install the required dependencies:
# With Bash
$ bash setup/setup.sh# With Conda
$ conda env create -f setup/environment.yaml
$ conda activate readme_ai
$ pip install -r requirements.txt# With Poetry
$ poetry install# With Docker
$ docker pull zeroxeli/readme-ai:v0.1.0Use 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:
-kor--api-key: Your OpenAI API key.-oor--output: The output path for your README.md file.-ror--repository: The URL or path to your code repository.-tor--template: The README template format to use. (Coming soon!)
python src/main.py --api-key abc123 --output readme-ai.md --repository https://github.com/eli64s/readme-aiAlternatively, export your OpenAI API key as an environment variable and run the following command:
conda activate readme_ai
export OPENAI_API_KEY=sk123abc456def7890
python src/main.py -o readme-ai.md -r https://github.com/eli64s/readme-ai# With Poetry
poetry shell
export OPENAI_API_KEY=sk123abc456def7890
poetry run python src/main.py -o readme-ai.md -r https://github.com/eli64s/readme-ai# Run with Docker
docker run -it -e OPENAI_API_KEY="your-api-key" -v "$(pwd)":/app -w /app zeroxeli/readme-ai:v0.1.0 \
python src/main.py -o readme-ai.md -r https://github.com/eli64s/readme-aiTo run the unit-tests for README-AI, use the following command.
bash scripts/test.sh- Add additional language support for populating the installation, usage, and test README sections.
- Design and implement a variety of README template formats and styles.
- Add feature to select the output language of the README file (i.e. CN, ES, FR, JA, KO, RU).
- Create UI with Textual or another framework to improve user experience.
Badges