Skip to main content

A wrapper on flake8 that uses GPT-4o mini to automatically fix code

Project description

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:

pip install rooq

Usage

To use Rooq, simply run the following command in your terminal:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rooq-0.1.0.tar.gz (11.2 kB view hashes)

Uploaded Source

Built Distribution

rooq-0.1.0-py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page