# 📦 Installation

Complete installation guide for Ryoma AI with all database connectors and optional features.

## 📋 Prerequisites

- **Python 3.9+** - Ryoma requires Python 3.9 or higher
- **API Key** - OpenAI, Anthropic, or other supported LLM provider
- **Database Drivers** - For your specific database (optional)

## 🚀 Quick Installation

### Basic Installation
```bash
pip install ryoma_ai
```

This installs the core Ryoma package with basic functionality.

### With Database Support
```bash
# PostgreSQL support
pip install ryoma_ai[postgres]

# MySQL support
pip install ryoma_ai[mysql]

# Snowflake support
pip install ryoma_ai[snowflake]

# BigQuery support
pip install ryoma_ai[bigquery]

# All database connectors
pip install ryoma_ai[all]
```

## 🗄️ Database-Specific Setup

### PostgreSQL
```bash
pip install ryoma_ai[postgres]
```

```python
from ryoma_data.sql import DataSource

datasource = DataSource(
    "postgres",
    host="localhost",
    database="mydb",
    user="user",
    password="password"
)
```

### Snowflake
```bash
pip install ryoma_ai[snowflake]
```

```python
from ryoma_data.sql import DataSource

datasource = DataSource(
    "snowflake",
    account="your-account",
    user="your-user",
    password="your-password",
    database="your-database",
    warehouse="your-warehouse"
)
```

### BigQuery
```bash
pip install ryoma_ai[bigquery]
```

```python
from ryoma_data.sql import DataSource

datasource = DataSource(
    "bigquery",
    project_id="your-project-id",
    credentials_path="/path/to/service-account.json"
)
```

## 🧠 LLM Provider Setup

### OpenAI
```bash
export OPENAI_API_KEY="your-openai-api-key"
```

```python
from ryoma_ai.agent.sql import SqlAgent

agent = SqlAgent(model="gpt-4", mode="enhanced")
```

### Anthropic Claude
```bash
pip install anthropic
export ANTHROPIC_API_KEY="your-anthropic-api-key"
```

```python
agent = SqlAgent(model="claude-3-sonnet-20240229", mode="enhanced")
```

### Local Models (Ollama)
```bash
# Install Ollama
curl -fsSL https://ollama.ai/install.sh | sh
ollama pull codellama:13b

pip install ollama
```

```python
from ryoma_ai.llm.provider import load_model_provider

model = load_model_provider(
    model_id="gpt4all:codellama-13b.gguf",
    model_type="chat",
    model_parameters={"allow_download": True}
)
agent = SqlAgent(model=model, mode="enhanced")
```

## ✅ Verify Installation

```python
import ryoma_ai
print(f"Ryoma AI version: {ryoma_ai.__version__}")

# Test basic functionality
from ryoma_ai import Ryoma
from ryoma_data import DataSource

# Create an in-memory SQLite datasource
datasource = DataSource("sqlite", database=":memory:")

# Create Ryoma and agent
ryoma = Ryoma(datasource=datasource)
agent = ryoma.sql_agent(model="gpt-3.5-turbo", mode="basic")

print("✅ Ryoma AI installation successful!")
```

## 🎯 Next Steps

- **[Quick Start Guide](../getting-started/quickstart.md)** - Get up and running in 5 minutes
- **[Advanced Setup](../getting-started/advanced-setup.md)** - Production configuration
- **[Examples](../getting-started/examples.md)** - Real-world use cases
- **[API Reference](../reference/index.md)** - Complete documentation