This is a vim plugin that allows you to simulate rubber duck programming by using the chatGPT API to generate code suggestions and natural language explanations based on the selected lines of code and a user-specified query.
Rubber duck programming is a debugging technique in which explaining one's code to an inanimate object, such as a rubber duck, helps to identify and fix errors or improve the code. This vim plugin uses the chatGPT API to simulate this process by providing code suggestions and explanations in response to the user's query.
To install the plugin, copy the vim-python-script-runner.vim file to your ~/.vim/plugin directory, along with the Python script, and edit the path to the python script in the vim plugin. You'll also need to have requests installed for the Python script.
- Open a file in vim and enter Visual mode (by pressing
v) - Select the lines of code you want to improve or debug
- Press the key mapped to the
RunPythonScriptfunction (e.g.<F9>) - Enter your query when prompted (e.g. "How do I rewrite this more idiomatically?")
- The chatGPT API will generate code suggestions and natural language explanations based on your selected lines and query
Here is an example of how to use the query function from the client.py file as a library:
# Import the query function from the client.py file
from client import query
# Set the arguments for the query function
args = {
"lines": "the selected lines of code",
"filename": "the active buffer's filename",
"query": "the user-specified query",
"api_key": "the chatgpt API key",
"model": "the chatgpt model to use",
}
# Call the query function with the specified arguments
response = query(args)
# Print the response from the chatgpt API
print(response.json())
This code imports the query function from the client.py file, sets the arguments for the function, and then calls the function with the specified arguments. The query function makes a request to the chatGPT API using the provided arguments, and returns the response from the API. The response is then printed to the console using the print function.
To use the query function as a library, you will need to have the client.py file in the same directory as the file where you are calling the query function, and you will also need to have the requests module installed. Let me know if you have any other questions!
The vim-python-script-runner.vim file contains the following configuration variables that you can modify:
g:python_script_path: The path to the Python script to run. The default value is'python-script.py'.RunPythonScriptfunction: The function that runs the Python script. You can map it to a key by adding a line likennoremap <F9> :call RunPythonScript()<CR>(to map it to<F9>).
The python-script.py file is a sample Python script that shows how to use the chatGPT API to generate code suggestions and natural language explanations based on the selected lines, active buffer's filename, and user-specified query. It receives these arguments from the vim plugin, and makes a post request to the chatGPT API with the appropriate data.
You can modify this script to customize the chatGPT API request and the handling of the response.
Rubber duck programming is a useful technique for improving code and debugging errors. By explaining one's code to an inanimate object, one is forced to articulate their thought process and consider their code from a different perspective, which can help identify and fix errors or improve the code.
Additionally, having a senior developer or mentor act as a "rubber duck" can be beneficial for junior developers, as it provides an opportunity to learn from experienced developers and gain exposure to their thought processes and problem-solving strategies.
This vim plugin and Python script were co-ideated with Frankie and Assistant, a large language model trained by OpenAI.