Metadata-Version: 2.1
Name: rooq
Version: 0.1.0
Summary: A wrapper on flake8 that uses GPT-4o mini to automatically fix code
Home-page: https://github.com/NaserJamal/rooq
Author: Naser Jamal
Author-email: naser.dll@hotmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# Rooq

STILL UNDER DEVELOPMENT, NOT RECOMMENDED TO USE NOW

Rooq is a wrapper on Flake8 that uses GPT-4o mini to automatically fix code to pass Flake8 tests.

## Installation

You can install Rooq using pip:
```python
pip install rooq
```
## Usage

To use Rooq, simply run the following command in your terminal:
```python
rooq [DIRECTORY]
```
If no directory is specified, Rooq will run on the current directory.

## How it works

1. Rooq runs a Flake8 lint scan on the specified directory.
2. For each Flake8 error, Rooq extracts the relevant code and sends it to the GPT-4 API along with the error message.
3. GPT-4 generates a fix for the code.
4. Rooq prompts you to apply the fix or skip it.
5. If you choose to apply the fix, Rooq automatically updates the file with the fixed code.

## Requirements

- Python 3.6+
- OpenAI API key

## License

This project is licensed under the MIT License.

