Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 3.84 KB

gpt4readability_gpt4_readme.md

File metadata and controls

70 lines (45 loc) · 3.84 KB
Raw

GPT4Readability

License Badge Issues Badge Pull Requests Badge Contributors Badge contributions welcome

Welcome to GPT4Readability! This tool is designed to automatically generate a README.md and suggest code improvements for any code repository. It's like having your own personal documentation and code review expert, available at any time! 😃

Other than this sentence this readme file and this suggestions file were both generated by GPT4Readability using gpt-3.5-turbo. Any other changes made will be listed below:

  • I added the version (0.0.8) to the installation section.
  • UPDATE: README generation (suggestions coming soon!) is now integrated into Huggingface Spaces 🤗 using Gradio. Try out the Web Demo: Hugging Face Spaces

Main Functionalities

  1. README Generation: GPT4Readability can generate a comprehensive README.md file for your code repository, providing a clear and detailed overview of your codebase.
  2. Code Improvement Suggestions: This tool can also suggest improvements to your code, helping you to optimize your codebase and adhere to best practices.

Installation

GPT4Readability requires Python 3.6 or higher. You can install it using pip:

pip install GPT4Readability==0.0.8

Dependencies

GPT4Readability requires the following Python packages:

  • langchain
  • openai
  • faiss-cpu
  • tiktoken
  • click
  • tqdm

These dependencies will be automatically installed when you install GPT4Readability using pip.

Usage

You can use GPT4Readability from the command line. Here's an example:

gpt4readability /path/to/your/code --function readme --output_readme MyREADME.md --model gpt-3.5-turbo

In this example, GPT4Readability will generate a README.md file for the code at /path/to/your/code, and the output will be written to MyREADME.md. The --model option allows you to choose between OpenAI's GPT-3.5-turbo and GPT-4 models.

Author

GPT4Readability is developed by Dennis Johan Loevlie. You can contact him at loevliedenny@gmail.com.

Contributing

Contributions are welcome! Here's how you can contribute:

  • Report a Bug: If you find a bug, please open an issue on GitHub.
  • Make a Pull Request: If you've made an improvement to the code, please open a pull request on GitHub.
  • Get Support: If you need help using GPT4Readability, you can open an issue on GitHub.
  • Make a Donation: If you find GPT4Readability useful and want to support its development, you can make a donation by emailing loevliedenny@gmail.com.
  • Commercial Support: For commercial support, please contact loevliedenny@gmail.com.

License

GPT4Readability is licensed under the MIT License. For more details, see the LICENSE file.

Thank you for using GPT4Readability! We hope you find it useful. Happy coding! 🤣