Skip to main content

A CLI tool that could debug, explain and create scripts using ChatGPT

Project description

GPT Developer Tools

A CLI utility based on OpenAI's ChatGPT that helps developers in:

  • Debugging
  • Explaning/Documenting an undocumented script
  • Creating new scripts based on prompt

Installation

Prerequisites

  1. python3 and python3-pip packages should be installed.
  2. OpenAI API Key. You can generate one by visiting beta.openai.com

Local Installation

  1. Install gpt-developer-tools PyPI package using pip.
python3 -m pip install gpt-developer-tools
  1. Export OPENAI_API_KEY environment variable.
export OPENAI_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  1. Run gdt command with arguments and options.
gdt explain --path ./gpt_developer_tools.py 

Usage

  • To debug a script with gdt
gdt debug --path ./setup.py
  • To debug first 7 lines of a script
gdt debug --path ./setup.py --line-end 7
  • To debug specific lines of a script
gdt debug --path ./setup.py --line-start 7 --line-end 17
  • To debug a script with a different prompt
gdt debug --path ./setup.py --line-start 7 --line-end 17 --prompt-message "Debug this script"
  • To fetch an explanation/documentation for a script
gdt explain --path ./setup.py --line-start 7 --line-end 17 --prompt-message "Explain this script to me line by line"
  • To create and save a script
gdt create -pm "Write a merge sort program in Java" -w --path ./sorting.java

Sample Output

Input Script: ./gpt_developer_tools.py

ChatGPT's Response:


if __name__ == '__main__':
    cli()

This script is used to debug or explain a script using ChatGPT. The script uses the click library 
to create a command line interface and import the requester and utils modules from the src package. 
The cli() function is used to create the command line group. The debug() and explain() functions are 
used to debug or explain a script respectively. Both functions take in the path to the script, the 
starting and ending line of the script, the model engine, max tokens, number of outputs, temperature 
and prompt message to be used by ChatGPT. The open_ai_api_key is retrieved from the environment 
variable OPENAI_API_KEY and is used to send the request to ChatGPT. Finally, the cli() function is 
called to execute the command line interface.

Development and Testing

  1. Create virtual environment.
python3 -m virtualenv venv
  1. Activate virtual environment.
source venv/bin/activate
  1. Install CLI utility gdt
python3 -m pip install --editable .
  1. Add your OpenAI API key as environment variable. You can generate one from beta.openai.com if you already have an OpenAI account.
export OPENAI_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  1. Run gdt utility with target script passed as path
gdt explain --path ./gpt_developer_tools.py 

Follow OpenAI's API Documentation for details related to models and predictions.

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

gpt-developer-tools-0.0.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gpt_developer_tools-0.0.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file gpt-developer-tools-0.0.1.tar.gz.

File metadata

  • Download URL: gpt-developer-tools-0.0.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for gpt-developer-tools-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f9313bd6400abc3e6d7219082d5733b534ac4a1ff4eb0f5d4a0347e0b3969ac0
MD5 be61dca046bae6b4adb425176917e119
BLAKE2b-256 1a1499f3d0f1541251744caffa1ca4bf3738d381cfab1ecad4fae27d65bf1e06

See more details on using hashes here.

File details

Details for the file gpt_developer_tools-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gpt_developer_tools-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eef7f8599a2ee7db02b6bf0f921517b8d912072ebbdcc9dc715e192227f751f8
MD5 0537bb4f19de2b9f45035153f7b6e7c1
BLAKE2b-256 8494e6e36470161bb3da71cd12a461d328d7260d729eea71a8e5fa0907cd153b

See more details on using hashes here.

Supported by

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