This repository contains a Python script that integrates OpenAI and Groq APIs to generate detailed technical specifications and outlines for DIY projects, specifically focusing on a drone control system using hand gestures and OpenCV. This AI agent can be customized for any detailed technical specifications and outlines. The strategy to achieve the best output for project-related ideas or guidelines is to effectively modify the prompts according to your requirements, allowing for a truly customized experience. π
- Tailored Assistance: Users can modify prompts to fit their specific project needs, allowing for a customized experience. π―
- Structured Guidance: The AI agent organizes information systematically, making it easier to understand complex project requirements. π
- Skill Development: By using the AI to generate project outlines and specifications, users can learn best practices in project planning and execution. π
- Encouragement: The AI's supportive framework helps users overcome the fear of starting DIY projects by breaking tasks into manageable steps. π οΈ
- API Integration: Uses OpenAI and Groq APIs to generate prompts and enhance technical details. π
- Technical Specification Generation: Provides a comprehensive breakdown of project requirements, architecture, and implementation plans. π
- Content Enhancement: Offers advanced technical details and suggestions for implementation, security, and performance optimization. π
- Chunked Processing: Processes content in manageable chunks to ensure complete responses without hitting token limits. π¦
- Error Handling: Includes basic error handling to manage API response issues.
β οΈ - Real-Life Application: The generated outlines can be applied to various fields, including software development, robotics, and educational projects, enhancing learning and practical skills. π€π»
- Python 3.x
- OpenAI Python Client
- Groq Python Client
For the best experience, use Visual Studio Code (VS Code) to edit the script. Open a terminal within VS Code or use your system's terminal for executing commands. π§
Ensure you have Python installed on your system. Then, install the required libraries using pip:
pip install openai groqTo securely manage your API keys, it is recommended to use environment variables. Here's how to set them up:
- Open the Command Prompt.
- Use the following commands to set your API keys:
set OPENAI_API_KEY=your_openai_api_key_here
set GROQ_API_KEY=your_groq_api_key_here- Open the terminal.
- Use the following commands to set your API keys:
export OPENAI_API_KEY=your_openai_api_key_here
export GROQ_API_KEY=your_groq_api_key_hereUpdate the script to retrieve your API keys from the environment variables instead of hardcoding them. Replace the lines that define openai_api_key and groq_api_key with:
import os
openai_api_key = os.getenv('OPENAI_API_KEY')
groq_api_key = os.getenv('GROQ_API_KEY')To utilize the AI agent effectively, modify the prompts in the script to suit your project's requirements. Here are some examples:
- For Software Development: "Create a software architecture plan for a web application that includes user authentication and data management."
- For Robotics: "Generate a specification for a robotic arm control system that focuses on precision and safety."
- For DIY Projects: "Outline a step-by-step guide for building a solar-powered garden light."
After setting up your environment, run the script to generate the technical specifications and outlines for your DIY project:
python your_script_name.pyThis script aims to provide a structured approach to tackling DIY projects by generating technical specifications and outlines. Use this as a guide to help overcome any apprehensions about starting your projects. π
If you find this repository useful, please support me by starring it β or contributing! Your support helps enhance this project and encourages the development of more useful tools. π