refactor: update SSH key variable name to SSH_PEM_CONTENT for consistency

docs/HUGGINGFACE_DEPLOYMENT.md

@@ -0,0 +1,148 @@
+# Hugging Face Deployment Guide
+
+This guide explains how to deploy your sales assistant application on Hugging Face Spaces with secure SSH key management.
+
+## Setting Up Secrets in Hugging Face
+
+1. **Go to your Hugging Face Space settings**
+   - Navigate to your space on Hugging Face
+   - Click on "Settings" tab
+   - Go to "Repository secrets"
+
+2. **Add the following secrets:**
+
+### Required Database Secrets
+```
+SSH_HOSTNAME=your.ssh.hostname.com
+SSH_PORT=22
+SSH_USERNAME=your-ssh-username
+SSH_PEM_CONTENT=-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----
+MYSQL_HOST=your.mysql.hostname.com
+MYSQL_PORT=3306
+MYSQL_USER=your-mysql-user
+MYSQL_PASSWORD=your-mysql-password
+MYSQL_DB=your-database-name
+```
+
+### Required API Keys
+```
+OPENAI_API_KEY=your-openai-api-key
+HUGGINGFACE_API_KEY=your-hf-api-key
+TAVILY_API_KEY=your-tavily-api-key
+BREVO_API_KEY=your-brevo-api-key
+COMPANY_EMAIL=your-company@email.com
+```
+
+### Optional Configuration
+```
+MODEL_NAME=gpt-5-mini
+MODEL_PROVIDER=openai
+LANGSMITH_API_KEY=your-langsmith-key
+LANGSMITH_TRACING_V2=true
+LANGSMITH_ENDPOINT=https://api.smith.langchain.com
+LANGSMITH_PROJECT=your-project-name
+```
+
+## SSH PEM Content Format
+
+When adding your SSH private key as `SSH_PEM_CONTENT`, use this format:
+
+```
+-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA0dtZotnwrz2jVSz2X3cZ...\n-----END RSA PRIVATE KEY-----
+```
+
+**Important Notes:**
+- Replace actual line breaks with `\n` 
+- Don't include quotes around the content
+- Keep the BEGIN/END lines intact
+- Include the `\n` characters exactly as shown
+
+## How It Works
+
+Our implementation now uses **paramiko directly** instead of temporary files:
+
+### ✅ Advantages of Current Implementation
+- **No temporary files**: PEM content is parsed directly in memory
+- **Hugging Face friendly**: Works seamlessly with HF secrets
+- **More secure**: No files written to disk
+- **Cloud native**: Perfect for containerized environments
+- **Fallback support**: Still works with file-based keys if needed
+
+### 🔄 Process Flow
+1. **Load environment variables** from HF secrets
+2. **Parse PEM content** directly using paramiko
+3. **Create SSH tunnel** using the parsed key object
+4. **Connect to database** through the secure tunnel
+5. **Clean shutdown** with no temporary files to clean up
+
+## Testing Locally
+
+To test your HF deployment locally:
+
+1. **Copy your secrets** to a local `.env` file (temporarily)
+2. **Run the test**: `uv run python test_files/db_test.py`
+3. **Verify output**: Look for "✅ Successfully created SSH key from PEM content"
+4. **Delete local .env**: Don't commit secrets to git!
+
+## Deployment Files for HF
+
+Make sure your Hugging Face space includes:
+
+- `app.py` (or your main application file)
+- `requirements.txt` (or `pyproject.toml`)
+- `README.md`
+
+Example `app.py` for Gradio:
+```python
+import gradio as gr
+from src.sales_assistant.ui_dashboard.gradio_app import create_app
+
+if __name__ == "__main__":
+    app = create_app()
+    app.launch()
+```
+
+## Troubleshooting
+
+### Common Issues:
+
+1. **"No SSH key available"**
+   - Check that `SSH_PEM_CONTENT` is properly set in HF secrets
+   - Verify the PEM format includes `\n` characters
+
+2. **"Could not parse PEM content"**
+   - Ensure the PEM content is properly formatted
+   - Check that the private key is valid
+
+3. **Connection timeout**
+   - Verify SSH hostname and port
+   - Check that the SSH server allows connections from HF infrastructure
+
+4. **MySQL connection failed**
+   - Verify MySQL credentials
+   - Check that MySQL server allows connections from your SSH server
+
+### Debug Mode
+
+Add this to your app for debugging:
+```python
+import os
+print(f"SSH_PEM_CONTENT loaded: {bool(os.getenv('SSH_PEM_CONTENT'))}")
+print(f"SSH_HOSTNAME: {os.getenv('SSH_HOSTNAME')}")
+```
+
+## Security Best Practices
+
+1. **Never commit secrets** to your git repository
+2. **Use HF secrets** for all sensitive information
+3. **Rotate SSH keys** periodically
+4. **Monitor access logs** on your SSH and database servers
+5. **Use strong passwords** for database accounts
+6. **Consider IP whitelisting** if possible
+
+## Performance Tips
+
+1. **Connection pooling**: The implementation reuses connections efficiently
+2. **Query optimization**: Use indexed columns for faster queries
+3. **Caching**: Consider caching frequently accessed data
+4. **Monitoring**: Set up monitoring for your database and SSH server

test_files/db_test.py

@@ -4,7 +4,7 @@ import pandas as pd
 
 # Validate configuration
 required_vars = [
-    'SSH_HOSTNAME', 'SSH_USERNAME', 'SSH_PKEY_PATH',
+    'SSH_HOSTNAME', 'SSH_USERNAME', 'SSH_PEM_CONTENT',
     'MYSQL_HOST', 'MYSQL_USER', 'MYSQL_PASSWORD', 'MYSQL_DB'
 ]
 validate_config_vars = validate_config(required_vars)