Skip to content

Installation

Prerequisites

  • Python: 3.10 or higher
  • pip or uv: Package manager

Installation

Install the Socket0 SDK:

bash
pip install socket0-sdk

Installation with CLI

Install with the Socket0 CLI (s0 command):

bash
pip install socket0-sdk[cli]

Installation with UV

If you're using the uv package manager:

bash
uv pip install socket0-sdk

Installation with CLI using UV

bash
uv pip install socket0-sdk[cli]

Development Installation

For development or contributing to the SDK:

Full Local Development Setup

This includes all dependencies: dev tools, testing framework, type checker, linter, CLI, and documentation:

bash
# Clone the repository
git clone https://github.com/socket0/socket0-python-sdk.git
cd socket0-python-sdk

# Install ALL Python dependencies (recommended for full library development)
uv sync --all-extras

# Install Node.js dependencies for documentation
npm install

Minimal Development Setup

If you only need the SDK without CLI features:

bash
git clone https://github.com/socket0/socket0-python-sdk.git
cd socket0-python-sdk

uv sync

npm install

Verify Installation

Verify the SDK is installed:

python
import socket0
print("SDK installed successfully")

Next Steps