Skip to content

📦 Installation Guide

System Requirements

  • Python 3.8 or higher
  • Ollama with Mistral:7b model
  • 4GB RAM (minimum)
  • Internet connection (for initial model download)
  • 10GB free disk space (for models and dependencies)

Installing Ollama

macOS/Linux

# Download and install Ollama
curl -fsSL https://ollama.ai/install.sh | sh

# Download the Mistral:7b model
ollama pull mistral:7b

Windows

  1. Download the installer from Ollama's website
  2. Run the installer
  3. Open a new command prompt and run:
    ollama pull mistral:7b
    

Installing shapi

pip install shapi

From Source

# Clone the repository
git clone https://github.com/yourusername/shapi.git
cd shapi

# Install in development mode
pip install -e .

Development Setup

For contributing to shapi:

git clone https://github.com/yourusername/shapi.git
cd shapi

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

# Install pre-commit hooks
pre-commit install

Verifying Installation

# Check Ollama is running
ollama list

# Check shapi installation
shapi --version

# Check system status
shapi status

Troubleshooting

Common Issues

  1. Ollama not found
  2. Ensure Ollama is properly installed and in your system PATH
  3. Try restarting your terminal or computer

  4. Model not found

  5. Verify you've pulled the correct model: ollama pull mistral:7b
  6. Check your internet connection

  7. Permission errors

  8. On Linux/macOS, you might need to use sudo for Ollama commands
  9. Consider adding your user to the docker group if using Docker

Next Steps

Footer -->