Metadata-Version: 2.1
Name: GPT4Readability
Version: 0.0.6
Summary: A tool to automatically generate a README.md and suggest code improvements for any python code repository
Home-page: https://github.com/loevlie/GPT4Readability
Author: Dennis Johan Loevlie
Author-email: loevliedenny@gmail.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: langchain
Requires-Dist: openai
Requires-Dist: faiss-cpu
Requires-Dist: tiktoken
Requires-Dist: click
Requires-Dist: tqdm

# GPT4Readability

[![License Badge](https://img.shields.io/github/license/loevlie/GPT4Readability)](https://github.com/loevlie/GPT4Readability/blob/main/LICENSE)
[![Issues Badge](https://img.shields.io/github/issues/loevlie/GPT4Readability)](https://github.com/loevlie/GPT4Readability/issues)
[![Pull Requests Badge](https://img.shields.io/github/issues-pr/loevlie/GPT4Readability)](https://github.com/loevlie/GPT4Readability/pulls)
[![Contributors Badge](https://img.shields.io/github/contributors/loevlie/GPT4Readability)](https://github.com/loevlie/GPT4Readability/graphs/contributors)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)

GPT4Readability is a powerful tool designed to automatically generate a comprehensive README.md file and suggest code improvements for any Python code repository. With its advanced AI capabilities, GPT4Readability goes beyond surface-level interpretation, allowing it to establish connections between disparate parts of code and gain an in-depth understanding of the code's functionality, structure, and intent.  

> Other than this sentence this readme file and this [suggestions file](https://github.com/loevlie/GPT4Readability/blob/main/suggestions.md) were both generated by GPT4Readability using gpt-3.5-turbo.  Any other changes made will be listed below:

* I added the version (0.0.5) to the installation section.
* UPDATE: README generation (suggestions coming soon!) is now integrated into [Huggingface Spaces 🤗](https://huggingface.co/spaces) using [Gradio](https://github.com/gradio-app/gradio). Try out the Web Demo: [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/JohanDL/GPT4Readability)

## Features

- Automatic generation of a detailed README.md file for your Python 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:

```shell
pip install GPT4Readability==0.0.5
```

## Usage

GPT4Readability provides two main functionalities: README generation and code improvement suggestions. You can choose to use either one or both of these functions.

### README Generation

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

```bash
gpt4readability <path> --function readme --output_readme README.md --model <model>
```

Replace `<path>` with the path to your codebase directory and `<model>` with the desired model to use (either "gpt-3.5-turbo" or "gpt-4").

### Code Improvement Suggestions

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

```bash
gpt4readability <path> --function suggestions --output_suggestions suggestions.md --model <model>
```

Replace `<path>` with the path to your codebase directory and `<model>` with the desired model to use (either "gpt-3.5-turbo" or "gpt-4").

## Authors

GPT4Readability is developed and maintained by Dennis Johan Loevlie. For any inquiries or support, please contact Dennis Johan Loevlie at loevliedenny@gmail.com.

## Contributing

Contributions to GPT4Readability are welcome! If you encounter any issues or have suggestions for improvements, please report them by opening an issue on the [GitHub repository](https://github.com/loevlie/GPT4Readability/issues).

To contribute code changes, follow these steps:

1. Fork the repository on GitHub.
2. Create a new branch from the main branch.
3. Make your desired changes and commit them.
4. Push your branch to your forked repository.
5. Open a pull request on the main repository.

Please ensure that your code changes adhere to the coding style and guidelines of the project.

## Support

For support or assistance with using GPT4Readability, please contact Dennis Johan Loevlie at loevliedenny@gmail.com.

## License

GPT4Readability is licensed under the MIT License. See the [LICENSE](https://github.com/loevlie/GPT4Readability/blob/main/LICENSE) file for more details.
