Getting Started

Get up and running with Share of Search analysis in minutes.

Installation

# Clone the repository
git clone https://github.com/your-org/Share_of_Search.git
cd Share_of_Search

# Install dependencies
pip install -r requirements.txt

# For documentation building
pip install -r docs/requirements-docs.txt

Configuration

Create a .env file with your API keys:

SERPAPI_KEY=your_serpapi_key_here
OPENAI_API_KEY=your_openai_key_here  # Optional, for AI insights

Quick Start

python runme.py

Results will be saved to outputs/luxury_watches/.

Next Steps

  • Review the configuration in config.yaml

  • Explore the User Guides for detailed tutorials

  • See Examples for real-world use cases