CodeHelper is a smart coding assistant powered by Google's Gemini API. This tool is designed to assist developers by providing detailed explanations of code, offering suggestions for improvements, and helping with debugging. Whether you're learning new programming concepts or fine-tuning your code, CodeHelper is here to support you in enhancing your development workflow.
- Explain Code: Get a detailed explanation of your code, including its purpose, functionality, and important concepts used.
- Suggest Improvements: Receive suggestions to improve the efficiency, readability, and structure of your code.
- Debug Code: Identify potential issues in your code and receive recommended fixes. You can even include an error message for context.
- Comprehensive Analysis: A one-stop solution that combines explanations, improvement suggestions, and debugging insights to give you a well-rounded review of your code.
To run CodeHelper, you'll need:
- Python 3.7 or higher
- A Gemini API key (This will be used to generate code explanations, improvements, and debugging suggestions)
-
Clone the Repository: Start by cloning the repository to your local machine.
git clone https://github.com/dotslashsimran/codehelper.git cd codehelper -
Install the Dependencies: Install the required Python libraries by running the following command.
pip install -r requirements.txt
-
Get Your API Key: You'll need a Gemini API key. You can find instructions to generate your API key in the Get Gemini API key.
-
Configure the API Key: When you run the application, you'll be prompted to enter your API key. This key will allow the tool to interact with Google's Gemini API to generate responses for your code.
Once the setup is complete, you're ready to use the CodeHelper!
In your terminal, navigate to the directory where the script is located.
Run the agent by executing:
python code_helper.py