Merge pull request #4 from pranitab07/AI

Finalized exe and created distribution package

Author: adityasarade

.env.example

@@ -0,0 +1,12 @@
+# Groq API Key for LLM
+GROQ_API_KEY=your_groq_api_key_here
+
+# Database Configuration (used in db_config.yaml)
+DB_PASSWORD=your_database_password
+DB_NAME=your_database_name
+
+# Vector Store Configuration (if using Pinecone)
+PINECONE_API_KEY=your_pinecone_api_key_here
+
+# MLflow Configuration (optional)
+MLFLOW_TRACKING_URI=http://127.0.0.1:5000

.gitignore

@@ -56,6 +56,7 @@ coverage.xml
 *.log
 
 # Sphinx documentation
+docs/
 docs/_build/
 
 # PyBuilder
@@ -67,6 +68,7 @@ target/
 # Database
 *.db
 *.rdb
+db_config.yaml
 
 # Pycharm
 .idea
@@ -91,4 +93,9 @@ target/
 *.swo
 
 # Mypy cache
-.mypy_cache/
+.mypy_cache/
+
+BUILD.md
+SETUP_INSTRUCTIONS.md
+CHANGES_AND_NEXT_STEPS.md
+.claude/

Docker-Compose.yaml

@@ -7,11 +7,7 @@
 PROJECT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 BUCKET = [OPTIONAL] your-bucket-for-syncing-data (do not include 's3://')
 PROFILE = default
-<<<<<<< HEAD
-PROJECT_NAME = sql_query_completion
-=======
-PROJECT_NAME = sql_code_completion
->>>>>>> main
+PROJECT_NAME = query_pilot
 PYTHON_INTERPRETER = python3
 
 ifeq (,$(shell which conda))

Makefile

@@ -103,29 +103,44 @@ pip install -r requirements.txt
 ```
 
 ### 4. Set Up Environment Variables
- 
-Create a `.env` file in the project root:
- 
+
+Copy the example environment file and configure it:
+
+```bash
+cp .env.example .env
+```
+
+Edit `.env` file with your credentials:
+
 ```env
 GROQ_API_KEY=your_groq_api_key_here
+DB_PASSWORD=your_database_password
+DB_NAME=your_database_name
 PINECONE_API_KEY=your_pinecone_api_key_here  # Optional, only for Pinecone
-PINECONE_ENVIRONMENT=your_pinecone_env_here  # Optional, only for Pinecone
 ```
- 
+
 ### 5. Configure Database Connection
- 
-Edit `db_config.yaml` with your database credentials:
- 
+
+Copy the example database config and configure it:
+
+```bash
+cp db_config.yaml.example db_config.yaml
+```
+
+The `db_config.yaml` file uses environment variables for sensitive data:
+
 ```yaml
 db:
   type: mysql  # or postgres
-  user: your_username
-  password: your_password
+  user: root
+  password: ${DB_PASSWORD}  # Reads from .env
   host: localhost
   port: 3306  # 5432 for PostgreSQL
-  name: your_database_name
+  name: ${DB_NAME}  # Reads from .env
   sample_rows: 2
 ```
+
+**Note**: The actual `db_config.yaml` file is gitignored for security. Always use the template file as a reference.
 
 ### 6. Download and Prepare Data
 

README.md

@@ -0,0 +1,215 @@
+# QueryPilot Setup Instructions
+
+Thank you for downloading QueryPilot! Follow these simple steps to get started.
+
+## Prerequisites
+
+Before you begin, make sure you have:
+
+- ✅ Windows 10 or higher
+- ✅ MySQL Workbench or pgAdmin 4 installed
+- ✅ An active database (MySQL or PostgreSQL)
+- ✅ Groq API key (free at https://console.groq.com)
+- ✅ Pinecone API key (optional, only if using Pinecone vector store)
+
+## Quick Start (5 minutes)
+
+### Step 1: Configure Environment Variables
+
+1. Locate the file named `.env.example` in this folder
+2. Rename it to `.env` (remove the `.example` extension)
+3. Open `.env` with a text editor (Notepad, VS Code, etc.)
+4. Fill in your credentials:
+
+```env
+GROQ_API_KEY=your_groq_api_key_here
+DB_PASSWORD=your_database_password
+DB_NAME=your_database_name
+PINECONE_API_KEY=your_pinecone_key_here  # Only if using Pinecone
+```
+
+**Where to get API keys:**
+- **Groq API Key**: Sign up at https://console.groq.com (free tier available)
+- **Pinecone API Key**: Sign up at https://www.pinecone.io (only if using Pinecone vector store)
+
+### Step 2: Configure Database Connection
+
+1. Locate the file named `db_config.yaml.example`
+2. Rename it to `db_config.yaml`
+3. Open `db_config.yaml` and verify the settings:
+
+```yaml
+db:
+  type: mysql  # Change to 'postgres' if using PostgreSQL
+  user: root   # Your database username
+  password: ${DB_PASSWORD}  # Uses value from .env
+  host: localhost
+  port: 3306  # Use 5432 for PostgreSQL
+  name: ${DB_NAME}  # Uses value from .env
+  sample_rows: 2
+```
+
+**Note**: The `${DB_PASSWORD}` and `${DB_NAME}` placeholders will automatically use the values you set in the `.env` file.
+
+### Step 3: Run QueryPilot
+
+1. Double-click `QueryPilot.exe`
+2. You should see: `👀 Listening for Ctrl+C and Tab... (press Esc to quit)`
+3. **Success!** QueryPilot is now running.
+
+## How to Use QueryPilot
+
+### Step 1: Open Your SQL Editor
+
+Open MySQL Workbench or pgAdmin 4 (must be one of these)
+
+### Step 2: Ask Query using comments
+
+Ask your question:
+
+```sql
+-- Fetch me the data for employees having more than 20LPA CTC 
+```
+
+### Step 3: Get AI Suggestions
+
+1. Select your question (comment)
+2. Press **Ctrl+C** to trigger QueryPilot
+3. Wait a moment for the AI suggestion to appear
+
+### Step 4: Accept or Dismiss
+
+- Press **Tab** to accept and insert the suggestion
+- Press any other key to dismiss it
+
+### Other Hotkeys
+
+- **Ctrl+Z**: Remove ghost text
+- **Ctrl+Shift+C**: Clear session memory
+- **Esc**: Quit QueryPilot
+
+## Example Workflow
+
+```sql
+-- 1. Ask your question
+-- Fetch me the data for employees having more than 20LPA CTC 
+
+-- 2. Select the statement and press Ctrl+C
+
+-- 3. QueryPilot shows suggestion:
+/* suggestion: SELECT * FROM Employees WHERE CTC > 2000000; */
+
+-- 4. Press Tab to accept, or any other key to dismiss
+```
+
+## Configuration (Optional)
+
+You can customize QueryPilot by editing `params.yaml`:
+
+### Change Vector Store
+
+```yaml
+vector_store:
+  type: faiss  # Options: faiss, pinecone, chromadb
+```
+
+### Adjust Session Memory
+
+```yaml
+memory:
+  enable: true
+  limit: 3  # Remember last 3 queries
+```
+
+### Change Hotkeys
+
+```yaml
+triggers:
+  initiater: ctrl+c  # Change trigger key
+  filler: tab        # Change accept key
+```
+
+## Troubleshooting
+
+### Problem: "Cannot find .env file"
+
+**Solution:**
+- Make sure you renamed `.env.example` to `.env`
+- Ensure `.env` is in the same folder as `QueryPilot.exe`
+- Check that the file extension is `.env` (not `.env.txt`)
+
+### Problem: "Database connection failed"
+
+**Solution:**
+1. Verify your database is running
+2. Check credentials in `.env` file
+3. Make sure the database name exists
+4. Test connection with MySQL Workbench/pgAdmin 4 first
+
+### Problem: "API key invalid"
+
+**Solution:**
+1. Verify your Groq API key at https://console.groq.com
+2. Make sure there are no extra spaces in the `.env` file
+3. Check that you copied the entire key
+
+### Problem: "Vector store not found"
+
+**Solution:**
+
+If you see errors about missing vector store files, you need to prepare the data:
+
+**Option A - Use Pre-built Data (if provided):**
+- Check if `data/processed/` folder exists with vector store files
+- If not, see Option B
+
+**Option B - Build Vector Store Yourself:**
+
+This requires Python 3.8+. In a terminal:
+
+```bash
+# Install Python dependencies
+pip install -r requirements.txt
+
+# Download SQL dataset
+python src/loading_data.py --config params.yaml
+
+# Build vector store
+python src/build_vector_stores.py --config params.yaml
+```
+
+### Problem: Antivirus is blocking QueryPilot.exe
+
+**Solution:**
+- This is a false positive (common with packaged Python apps)
+- Add an exception for `QueryPilot.exe` in your antivirus settings
+- The exe is safe - it's just Python code packaged with PyInstaller
+
+### Problem: Suggestions are not appearing
+
+**Solution:**
+1. Make sure MySQL Workbench or pgAdmin 4 is the active window
+2. Check that you pressed Ctrl+C (not just C)
+3. Verify QueryPilot terminal shows "SQL Captured"
+4. Try again with a different SQL query
+
+### Problem: "Missing DLL" errors
+
+**Solution:**
+- Install Visual C++ Redistributable: https://aka.ms/vs/17/release/vc_redist.x64.exe
+- Restart your computer after installation
+
+## Performance Tips
+
+- **Faster suggestions**: Use FAISS vector store (default)
+- **Better suggestions**: Increase `vector_store.top_k` in `params.yaml`
+- **More context**: Increase `memory.limit` to remember more queries
+
+## Need More Help?
+
+- **Full Documentation**: See `README.md` in this folder
+- **Report Issues**: Contact the developer or check the project repository
+
+---
+
+**Enjoy using QueryPilot! Happy querying! 🚀**

SETUP_INSTRUCTIONS.md

@@ -0,0 +1,8 @@
+db:
+  type: mysql  # Change to 'postgres' if using PostgreSQL
+  user: root   # Your database username
+  password: ${DB_PASSWORD}  # Uses value from .env
+  host: localhost
+  port: 3306  # Use 5432 for PostgreSQL
+  name: ${DB_NAME}  # Uses value from .env
+  sample_rows: 2