pyGPTify is a Python code formatter that uses OpenAI's GPT-3.5 Turbo model to improve code readability and adherence to clean code principles. The script accepts a Python source code file and formats it iteratively, printing the differences between the original and the newly formatted code after each iteration.
- Make sure you have Python 3.6 or higher installed.
- Install the required libraries:
pip install ast difflib python-dotenv openai
-
Set up an API key for OpenAI. You can get one by signing up at OpenAI.
-
Create a
.envfile in the project folder and add the following line, replacingyour_openai_api_keywith your actual API key:
OPENAI_API_KEY=your_openai_api_key
To use pyGPTify, run the following command:
python pyGPTify.py <filename> [iterations]
<filename>: The path to the Python source code file you want to format.[iterations](optional): The number of iterations you want to run the formatting process. If not provided, the default value is 1.
python pyGPTify.py my_script.py 3
This command will format the my_script.py file three times, printing the differences between the original and the newly formatted code after each iteration.
This script is designed for formatting Python code and may not work as expected for other programming languages. It relies on OpenAI's GPT-3.5 Turbo model for formatting, so you'll need a valid API key to use the service.