Installation

Prerequisites

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

Standard Installation

Install the core Socket0 SDK without CLI tools:

pip install socket0-sdk

With CLI Tools

To include the optional command-line interface:

pip install socket0-sdk[cli]

This installs additional dependencies:

• typer - CLI framework
• rich - Terminal formatting
• python-dotenv - Environment variable support

Installation with UV

If you're using the uv package manager:

# Standard installation
uv pip install socket0-sdk

# With CLI tools
uv pip install socket0-sdk[cli]

Development Installation

For development or contributing to the SDK:

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

# Install Python dependencies with development tools
uv sync

# Install in editable mode
uv pip install -e .

# Install with CLI (editable)
uv pip install -e ".[cli]"

# Install Node.js dependencies for documentation
npm install

Verify Installation

Core SDK

import socket0
print(socket0.__version__)

With CLI

Verify the CLI is installed:

s0 --help

You should see the help output with available commands:

Usage: s0 [OPTIONS] COMMAND [ARGS]...

  Socket0 SDK CLI - Vault management and SDK development tools

Options:
  --help  Show this message and exit.

Commands:
  sdk     SDK development and management tools
  vault   Vault and secret management

Next Steps

• CLI Overview - Learn how to use the CLI tools
• Vault Guide - Start managing secrets
• API Reference - Explore the REST API client