# LeadgenAgent Installation Guide

## Quick Start
1. Install Python 3.9 or higher (updated requirement)
2. Install Ollama from https://ollama.ai
3. Request authentication credentials from raminderpal@anduril.uk
4. Clone the LeadgenAgent repository
5. Set up your environment following the steps below

## Detailed Installation Steps

### 1. Environment Setup
```bash
# Create a virtual environment
python -m venv leadgen_env

# Activate the virtual environment
# For Windows:
leadgen_env\Scripts\activate
# For Mac/Linux:
source leadgen_env/bin/activate

# Install required packages
pip install -r requirements.txt

# Install spaCy language model
python -m spacy download en_core_web_sm
```

### 2. Ollama Setup
```bash
# Start Ollama service
ollama serve

# In a new terminal, pull the required model
ollama pull llama3.1:8b
```

### 3. Security Setup
```bash
# Request authentication credentials
# Contact: raminderpal@anduril.uk with:
# - Your name
# - Organization
# - Intended use case

# Store credentials securely
# DO NOT share or commit credential files
```

### 4. Project Structure
Create the following folder structure:
```
leadgen/
├── main.py
├── requirements.txt
├── words.txt
├── uploads/
│   ├── background_info.txt
│   └── original_client_list.xlsx
└── downloads/
```

## Input File Requirements

### background_info.txt
Format your file as follows:
```
company: Your Company Name
client_profile: keyword1, keyword2, keyword3
```

### original_client_list.xlsx
Required columns:
- name: Company/client name
- website: Company website URL (optional)
- publications: Recent publications (optional)
- news: Recent news (optional)
- relevance: Relevance description (optional)

### words.txt
- Reference file for name validation
- Use provided example file
- One word per line
- Required for contact name validation

## Configuration Steps

1. Open main.py
2. Replace the email in `Entrez.email = "raminderpal@hitchhikersai.org"` with your email
3. Verify Ollama settings:
   ```python
   OLLAMA_MODEL = 'llama3.1:8b'
   ```
4. Place your authentication credentials in the auth directory

## Running the Application
```bash
# Ensure Ollama is running
ollama serve

# In a new terminal with activated environment
python main.py

# Enter authentication credentials when prompted
```

## System Requirements
- Python 3.9 or higher
- 16GB RAM minimum
- 5GB free disk space
- Active internet connection
- Windows/Mac/Linux operating system
- Cryptography module installed

## Security Notes
- Keep authentication credentials secure
- Do not share credentials with others
- Report any security concerns immediately
- Regular password rotation recommended

## Troubleshooting

Common Issues:
1. **ModuleNotFoundError**: Run `pip install -r requirements.txt` again
2. **Ollama not found**: Verify Ollama installation and `ollama serve` is running
3. **File not found errors**: Check folder structure and file names
4. **Memory errors**: Close other applications or increase available RAM
5. **Authentication errors**: Verify credentials and contact support
6. **Encryption errors**: Check cryptography module installation
7. **SpaCy errors**: Reinstall language model with `python -m spacy download en_core_web_sm`

For additional support:
- Technical support: raminderpal@anduril.uk
- General inquiries: raminderpal@hitchhikersai.org
- Visit: https://www.hitchhikersai.org/leadgenagent