8000 Merge branch 'main' of https://github.com/LikithMeruvu/Codestral-pyth… · LikithMeruvu/Python-coding-Agent@c623168 · GitHub
[go: up one dir, main page]

Skip to content

Commit c623168

Browse files
committed
2 parents 13d8fac + a7dcb4a commit c623168

File tree

1 file changed

+79
-1
lines changed

1 file changed

+79
-1
lines changed

README.md

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,79 @@
1-
# Codestral-python-agent
1+
2+
3+
# Python Coding Agent
4+
5+
A versatile Python agent utilizing OpenAI's GPT-3.5 to assist with various coding tasks, from generating code snippets to providing debugging help. This project aims to streamline the coding process by leveraging AI for enhanced productivity and learning.
6+
7+
## Table of Contents
8+
9+
- [Features](#features)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [File Descriptions](#file-descriptions)
13+
- [License](#license)
14+
- [Contact](#contact)
15+
16+
## Features
17+
18+
- **Code Generation:** Generate code snippets based on natural language prompts.
19+
- **Debugging Assistance:** Get help with debugging Python code.
20+
- **Code Explanation:** Understand complex code with detailed explanations.
21+
- **Interactive Sessions:** Engage in interactive coding sessions with the agent.
22+
23+
## Installation
24+
25+
1. **Clone the Repository:**
26+
```bash
27+
git clone https://github.com/LikithMeruvu/Python-coding-Agent.git
28+
cd Python-coding-Agent
29+
```
30+
31+
2. **Create and activate a virtual environment:**
32+
```bash
33+
python -m venv venv
34+
source venv/bin/activate # On Windows use `venv\Scripts\activate`
35+
```
36+
37+
3. **Install Dependencies:**
38+
```bash
39+
pip install -r requirements.txt
40+
```
41+
42+
## Usage
43+
44+
Open Respective Files and Add you API info in Variables specified by 'your_api'
45+
46+
1. **Run the Agent with GroqAPI:**
47+
```bash
48+
python python-coding-agent.py
49+
```
50+
51+
**Run the Agent with OPENAI_API:**
52+
```bash
53+
python openai-agent.py
54+
```
55+
56+
1. **Interact with the Agent:**
57+
- The agent will prompt you for input. Provide your coding queries, and the agent will respond accordingly.
58+
59+
## File Descriptions
60+
61+
- **langgraph.py:** Contains the logic for the agents in langgraph.
62+
- **openai-agent.py:** Manages interactions with the OpenAI API.
63+
- **python-coding-agent.py:** Core functionality of the Python coding agent.
64+
- **temp.py:** Temporary file for testing and experimentation.
65+
- **requirements.txt:** Lists all the dependencies required to run the project.
66+
- **README.md:** Provides an overview and usage instructions for the project.
67+
- **LICENSE:** License information for the project.
68+
69+
70+
## License
71+
72+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
73+
74+
## Contact
75+
76+
For any questions or suggestions, please open an issue or reach out to the maintainer:
77+
78+
- GitHub: [LikithMeruvu](https://github.com/LikithMeruvu)
79+

0 commit comments

Comments
 (0)
0