GPT4Readability 0.1.2

A tool to automatically generate a README.md and suggest code improvements for any code repository

GPT4Readability

GPT4Readability is a powerful tool designed to automatically generate a README.md file and suggest code improvements for any code repository. It leverages the capabilities of OpenAI's GPT-3.5-turbo or GPT-4 model to analyze and interpret code, establish connections between different parts of the codebase, and gain an in-depth understanding of its functionality, structure, and intent.

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.9) to the installation section.
• UPDATE: README generation (suggestions coming soon!) is now integrated into Huggingface Spaces 🤗 using Gradio. Try out the Web Demo:
• I recently got access to GPT-4 so the GPT-4 version of the gpt4readability README can be found here GPT-4_Example
• The README file generation works with all programing languages but for now the code suggestions is still python only.

Features

• Automatic generation of a comprehensive README.md file for your codebase
• Suggestions for code improvements to enhance readability and maintainability

Installation

To use GPT4Readability, you need to have Python 3.6 or higher installed on your system. You can install GPT4Readability and its dependencies using the following command:

pip install GPT4Readability==0.0.9

Usage

GPT4Readability provides a command-line interface (CLI) for generating the README.md file and code improvement suggestions. You can use the following command to run GPT4Readability:

gpt4readability [path] [options]

Options

• --function, -f: Specify the function to use. Options are 'readme', 'suggestions', or 'both'. Default is 'both'.
• --output_readme, -or: Specify the output filename for the README.md file. Default is 'README.md'.
• --output_suggestions, -os: Specify the output filename for the code improvement suggestions. Default is 'suggestions.md'.
• --model, -m: Specify the model to use. Options are 'gpt-3.5-turbo' or 'gpt-4'. Default is 'gpt-3.5-turbo'.

Examples

To generate the README.md file for your codebase, run the following command:

gpt4readability /path/to/codebase --function readme

To generate code improvement suggestions for your codebase, run the following command:

gpt4readability /path/to/codebase --function suggestions

To generate both the README.md file and code improvement suggestions, run the following command:

gpt4readability /path/to/codebase --function both

Authors

GPT4Readability is developed and maintained by Dennis Johan Loevlie. You can contact the author via email at [e-mail].

Contributing

Contributions to GPT4Readability are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository.

Support

If you need support or have any questions, feel free to reach out to the author at [e-mail].

License

GPT4Readability is licensed under the MIT License.