Skip to main content

Installation & Setup

Get started with Synapse SDK in minutes.

Prerequisites​

Before installing Synapse SDK, ensure you have:

  • Python 3.10 or higher installed

Installation Methods​

Install from PyPI​

The easiest way to install Synapse SDK is via pip:

pip install synapse-sdk

Install with Optional Dependencies​

For additional features, install with extras:

# Install with all dependencies (Ray, optimization libraries)
pip install synapse-sdk[all]

# Install with dashboard dependencies (FastAPI, Uvicorn)
pip install synapse-sdk[dashboard]

# Install both
pip install synapse-sdk[all,dashboard]

Install from Source​

To get the latest development version:

git clone https://github.com/datamaker/synapse-sdk.git
cd synapse-sdk
pip install -e .

# With optional dependencies
pip install -e ".[all,dashboard]"

Verify Installation​

After installation, verify everything is working:

# Check version
synapse --version

# Run interactive CLI
synapse

# Run with devtools
synapse --dev-tools

Troubleshooting​

Common Issues​

  1. ImportError: No module named 'synapse_sdk'

    • Ensure you've activated your virtual environment
    • Check Python path: python -c "import sys; print(sys.path)"

  2. Connection timeout to backend

    • Verify your API token is correct
    • Check network connectivity
    • Ensure backend URL is accessible

Getting Help​

If you encounter issues:

  1. Check the Troubleshooting Guide
  2. Search GitHub Issues
  3. Join our Discord Community

Next Steps​