Installation¶

This guide covers the installation process for the Sikka Agent framework and its dependencies.

System Requirements¶

Python: 3.11 or higher
Operating Systems: Windows, macOS, Linux
RAM: 8GB minimum (16GB recommended for running larger models)
Disk Space: ~500MB for the framework and dependencies

Standard Installation¶

The recommended way to install Sikka Agent is via pip or uv:

pip install git+https://github.com/SikkaSoftware2015/sikka-agent.git@main#egg=sikkaagent

This will install the core framework and its essential dependencies.

Development Installation¶

For developers who want to contribute to Sikka Agent or need the latest features:

# Clone the repository
git clone https://github.com/SikkaSoftware2015/sikka-agent.git

# Navigate to the project directory
cd sikka-agent

# Install in development mode
pip install -e .

# Install development dependencies
pip install -e ".[dev]"

Optional Dependencies¶

Sikka Agent has several optional dependencies for specific features:

Video Analysis¶

pip install -e ".[video]"

Reference: From checking the setup.py file, the video extra includes "yt-dlp" and "ffmpeg-python".

Web Browsing¶

pip install -e ".[web]"

Reference: From checking the setup.py file, the web extra includes "playwright>=1.40.0" and "nest_asyncio>=1.5.0".

All Extensions¶

To install all optional dependencies:

pip install -e ".[all]"

Note: The setup.py file currently doesn't include PDF/OCR and Excel specific extras, but these dependencies might be included in the core requirements or could be installed separately as needed.

Verifying Installation¶

You can verify your installation by running:

import sikkaagent
print(sikkaagent.__version__)

Using Local Models with Ollama¶

Sikka Agent supports local models through Ollama:

Install Ollama from https://ollama.com/
Pull the models you want to use:
```
ollama pull llama3.1:8b
```
Start the Ollama server:
```
ollama serve
```

In your Sikka Agent code, specify the Ollama model:

from sikkaagent.models.model_configure import ModelConfigure
from sikkaagent.utils.enums import ModelPlatformType

model = ModelConfigure(
    model="llama3.1:8b",
    model_platform=ModelPlatformType.OLLAMA,
    url="http://localhost:11434/v1" # optional
)

Setting Up API Keys¶

Many of Sikka Agent's features require API keys for external services:

Create a .env file in your project directory
Add your API keys (as needed for your specific use case):

AWS_ACCESS_KEY_ID=your_aws_access_key
AWS_SECRET_ACCESS_KEY=your_aws_secret_key

Note: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are necessary for using AWS Bedrock endpoint.

Troubleshooting¶

Common Issues¶

Missing Dependencies¶

If you encounter errors about missing dependencies, try:

pip install -r requirements.txt

Version Conflicts¶

Version conflicts can be resolved using:

pip install git+https://github.com/SikkaSoftware2015/sikka-agent.git@main#egg=sikkaagent

Getting Help¶

If you encounter issues that aren't resolved by the troubleshooting steps:

Check the GitHub Issues
File a new issue with details about your environment and the problem