SETUP.md

# 🚀 Smart Auto-Complete - Setup Guide

This guide will help you set up and run the Smart Auto-Complete application.

## 📋 Prerequisites

- **Python 3.8+** (recommended: Python 3.9 or higher)
- **pip** (Python package installer)
- **API Keys** from one or both providers:
  - [OpenAI API Key](https://platform.openai.com/api-keys)
  - [Anthropic API Key](https://console.anthropic.com/)

## 🚀 Quick Installation

### Option 1: Automated Installation (Recommended)

```bash
# Run the installation script
python install.py
```

This will:
- Check Python version compatibility
- Install all required dependencies
- Set up environment configuration
- Run setup tests to verify everything works

### Option 2: Manual Installation

```bash
# 1. Install dependencies
pip install -r requirements.txt

# 2. Set up environment
cp .env.example .env

# 3. Edit .env file with your API keys
# Add your API keys to the .env file

# 4. Test the setup
python test_setup.py
```

## ⚙️ Configuration

### Environment Variables

Edit the `.env` file with your configuration:

```env
# Required: Add at least one API key
OPENAI_API_KEY=your_openai_key_here
ANTHROPIC_API_KEY=your_anthropic_key_here

# Optional: Customize settings
DEFAULT_PROVIDER=openai
MAX_SUGGESTIONS=5
DEBOUNCE_DELAY=300
CACHE_TTL=3600
```

### API Keys Setup

#### OpenAI API Key
1. Go to [OpenAI Platform](https://platform.openai.com/api-keys)
2. Create a new API key
3. Copy the key (starts with `sk-`)
4. Add to `.env` file: `OPENAI_API_KEY=sk-your-key-here`

#### Anthropic API Key
1. Go to [Anthropic Console](https://console.anthropic.com/)
2. Create a new API key
3. Copy the key (starts with `sk-ant-`)
4. Add to `.env` file: `ANTHROPIC_API_KEY=sk-ant-your-key-here`

## 🏃‍♂️ Running the Application

```bash
# Start the application
python app.py
```

The application will be available at: **http://localhost:7860**

## 🧪 Testing

### Run Setup Tests
```bash
python test_setup.py
```

### Run Unit Tests
```bash
# Install test dependencies (if not already installed)
pip install pytest pytest-cov

# Run all tests
python -m pytest tests/

# Run with coverage
python -m pytest tests/ --cov=src/
```

## 📁 Project Structure

```
Smart-Auto-Complete/
├── app.py                 # Main Gradio application
├── src/
│   ├── __init__.py
│   ├── autocomplete.py    # Core autocomplete logic
│   ├── api_client.py      # API integration layer
│   ├── cache.py           # Caching system
│   └── utils.py           # Utility functions
├── config/
│   ├── __init__.py
│   └── settings.py        # Configuration management
├── tests/
│   ├── __init__.py
│   ├── test_autocomplete.py
│   ├── test_api_client.py
│   └── test_cache.py
├── requirements.txt       # Python dependencies
├── .env.example          # Environment template
├── install.py            # Installation script
├── test_setup.py         # Setup verification
└── README.md             # Main documentation
```

## 🔧 Troubleshooting

### Common Issues

#### Import Errors
```bash
# Make sure you're in the correct directory
cd Smart-Auto-Complete

# Install dependencies
pip install -r requirements.txt
```

#### API Key Issues
- Verify your API keys are correct and active
- Check that keys are properly set in `.env` file
- Ensure you have sufficient API credits

#### Port Already in Use
```bash
# If port 7860 is busy, specify a different port
python app.py --server-port 7861
```

#### Permission Errors
```bash
# On macOS/Linux, you might need:
python3 app.py

# Or use virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
python app.py
```

### Debug Mode

Enable debug mode for detailed logging:

```bash
# Set in .env file
DEBUG_MODE=true
LOG_LEVEL=DEBUG
```

## 🎯 Usage Examples

### Email Writing
```
Input: "Dear Mr. Johnson,"
Context: Email
→ Suggests professional email continuations
```

### Code Documentation
```
Input: "// This function calculates"
Context: Code
→ Suggests technical documentation
```

### Creative Writing
```
Input: "Once upon a time, in a kingdom far away"
Context: Creative
→ Suggests story continuations
```

## 🔒 Security Notes

- API keys are stored locally in `.env` file
- Never commit `.env` file to version control
- Input text is sanitized before processing
- No user data is stored permanently

## 📞 Support

If you encounter issues:

1. Check this setup guide
2. Run `python test_setup.py` to diagnose problems
3. Check the console output for error messages
4. Verify your API keys and internet connection

## 🎉 Success!

If everything is working correctly, you should see:
- ✅ All setup tests passing
- 🌐 Application running at http://localhost:7860
- 💡 Real-time suggestions as you type

Enjoy using Smart Auto-Complete! 🚀