- 📦 Table of Contents
- 📍 Introdcution
- 🔮 Features
- 🏎💨 Getting Started
- 🧩 Roadmap
- 🤝 Contributing
- 📄 License
- 📧 Contact
- 🙏 Acknowledgments
README-AI is a Python package that provides an automated way to generate a README.md file and document your codebase. This package leverages OpenAI's GPT Davinci model to translate a given codebase to natural language, producing a structured project README template that includes codebase metadata and documentation.
The project is still under development and is opinionated in its setup, but it can be used as a starting point for projects that require documentation. The current version of README-AI is limited to codebases written in Python.
Have you met anyone who said they loved writing documentation? That’s why we're building this project, hope you enjoy!
| Codebase Documentation This project leverages OpenAI's GPT Davinci model to convert a given Python codebase into natural language, producing a well-structured project README template that includes codebase metadata, documentation and other essential details. |
 |
Visualize project dependencies and components in your README's header section with badges.
Profile Badges Analyzes your project's dependencies and requirements, displaying them as badges in the README's header section. |
 |
Why not a tree as well? Visualize your project's GitHub directories and files.
Project Tree Creates a GitHub directory tree to display in your README. |
 |
Creates directory and file setup/environment.yaml if missing, and writes the README installion guide.
Environment YAML Creates your project's environment yaml file and generates an installation guide section for others can use your project easily! |
 |
Before you begin, ensure that you have the following prerequisites installed:
- Python 3.6 or higher
- Conda package manager (recommended)
- Access to the OpenAI API (see OpenAI API Setup below)
Copy the url of your project's GitHub repository and update the code below in the conf/conf.toml file.
# GitHub
[github]
url = "<INSERT-GITHUB-REPO>"To use README-AI, you will need an API key for OpenAI. Follow the steps below to create an API key:
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.
- Clone the README-AI repository:
git clone https://github.com/eli64s/README-AI.git && cd README-AI- Create a new Conda environment and install the required dependencies:
conda env create -f setup/environment.yaml
conda activate README-AI- Set up the OpenAI API key by creating an environment variable:
export OPENAI_API_KEY=<your-api-key>Alternatively, you can set up the OpenAI API key in a .env file in the root directory of the project.
Once you have installed README-AI, you can generate a README file for your codebase by running the following command:
python src/main.py- Add additional language models on top of GPT-3 to fine tune text.
- Add compatability for additional languages. Rust next.
- Extend capabilities beyond code documentation.
- Implement different configuration file templates.
We welcome contributions to README-AI from the open-source community! If you would like to contribute, please see our contribution guidelines for more information.
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions or feedback about README-AI, please feel free to reach out. We would be happy to hear from you!
- Badge Icons: Aveek-Saha/GitHub-Profile-Badges