๐ Generate awesome README.md files from the terminal, powered by OpenAI's GPT language model APIs ๐ซ
Project description
README-AI
โฆ Generate beautiful and informative README.md documents.
โฆ Developed with OpenAI's GPT language model APIs.
๐ Table of Contents
- ๐ Table of Contents
- ๐ Overview
- ๐พ Demo
- โ๏ธ Features
- ๐ Getting Started
- ๐ 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
|
|
โ
๐
๐ Badges
โฆ Introduction, Badges, & Table of Contents
|
|
โ
๐
๐ง Prompted Text Generation
โฆ Features Table & Overview
|
|
โ
๐
๐ฒ Repository Tree
|
โ
๐
๐ฆ Dynamic User Setup Guides
โฆ Installation, Usage, & Testing
|
|
โ
๐
๐ฉโ๐ป 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!
๐ 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:
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.
๐ฆ Installation
Use any of the following methods to install project dependencies.
Pip (PyPI Package)
pip install readmeai
Docker (Docker Hub)
docker pull zeroxeli/readme-ai:latest
If you prefer to install the project dependencies locally, follow the steps below.
- Clone the readme-ai repository to your machine.
git clone https://github.com/eli64s/readme-ai
- Navigate to the readme-ai directory.
cd readme-ai
- 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:
-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!)lor--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
๐ Future Development
- Add additional language support for populating the installation, usage, and test README sections.
- Publish the readme-ai CLI app to PyPI readmeai.
- Create user interface and serve the readme-ai app via streamlit.
- Design and implement a variety of README template formats for different use-cases.
- Add support for writing the README in any language (i.e. CN, ES, FR, JA, KO, RU).
๐ Changelog
๐ค Contributing
๐ License
๐ Acknowledgments
Badges
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file readmeai-0.1.996.tar.gz.
File metadata
- Download URL: readmeai-0.1.996.tar.gz
- Upload date:
- Size: 30.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c9e25b7ca3ba5321ca614996ec79336991a76fe671a4c2285349ef7ede2124cd |
|
| MD5 | 5dbc655fef627f22984884fc00e0899e |
|
| BLAKE2b-256 | ac9c852789bee8951421ed77e9074274a7535cd0ff28b13e9bee222b9ffcc7b2 |
File details
Details for the file readmeai-0.1.996-py3-none-any.whl.
File metadata
- Download URL: readmeai-0.1.996-py3-none-any.whl
- Upload date:
- Size: 31.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aba81c8bc02212237ed850ebdb824960f5809b4306d7badd051545cfbc1c2bed |
|
| MD5 | cecc5771d3e42b0c7f5db488b0b7f0f1 |
|
| BLAKE2b-256 | 4178f8e87da20317d80fbbe029a6874eaa737d613568140aeec5527067c219ab |
