smplkit-sdk 3.0.1

Official Python SDK for the smplkit platform

smplkit Python SDK

The official Python SDK for smplkit — simple application infrastructure that just works.

Installation

pip install smplkit-sdk

Requirements

• Python 3.10+

Quick Start

from smplkit import SmplClient

# Option 1: Explicit API key
client = SmplClient(api_key="sk_api_...")

# Option 2: Environment variable (SMPLKIT_API_KEY)
# export SMPLKIT_API_KEY=sk_api_...
client = SmplClient()

# Option 3: Configuration file (~/.smplkit)
# [default]
# api_key = sk_api_...
client = SmplClient()

from smplkit import SmplClient

with SmplClient(api_key="sk_api_...") as client:
    # --- Runtime: resolve config values ---
    # Connect and read resolved key/value pairs for your service
    db = client.config.get("database")  # {"host": "...", "port": 5432}

    # --- Management: CRUD operations ---
    # List all configs
    configs = client.config.management.list()

    # Create a new config
    cfg = client.config.management.new("my_service", name="My Service")
    cfg.save()

    # Get a config by id
    cfg = client.config.management.get("my_service")

    # Delete a config
    client.config.management.delete("my_service")

    # --- Flags management ---
    flag = client.flags.management.newBooleanFlag("checkout-v2", default=False)
    flag.save()
    flags = client.flags.management.list()

    # --- Logging management ---
    logger = client.logging.management.new("sql", name="SQL Logger")
    logger.save()

For async usage:

from smplkit import AsyncSmplClient

async with AsyncSmplClient(api_key="sk_api_...") as client:
    # Runtime
    db = await client.config.get("database")

    # Management
    cfg = await client.config.management.get("my_service")
    configs = await client.config.management.list()

Configuration

All settings are resolved from three sources, in order of precedence:

1. Constructor arguments — highest priority, always wins.
2. Environment variables — e.g. SMPLKIT_API_KEY, SMPLKIT_ENVIRONMENT.
3. Configuration file (~/.smplkit) — INI-format with profile support.
4. Defaults — built-in SDK defaults.

Configuration File

The ~/.smplkit file supports a [common] section (applied to all profiles) and named profiles:

[common]
environment = production
service = my-app

[default]
api_key = sk_api_abc123

[local]
base_domain = localhost
scheme = http
api_key = sk_api_local_xyz
environment = development
debug = true

Constructor Examples

# Use a named profile
client = SmplClient(profile="local")

# Or configure explicitly
client = SmplClient(
    api_key="sk_api_...",
    environment="production",
    service="my-service",
)

For the complete configuration reference, see the Configuration Guide.

Error Handling

All SDK errors extend SmplError:

from smplkit import SmplError, SmplNotFoundError

try:
    config = client.config.management.get("nonexistent")
except SmplNotFoundError:
    print("Config not found")
except SmplError as e:
    print(f"SDK error: {e}")

Exception	Cause
SmplNotFoundError	Resource not found
SmplConflictError	Conflict (e.g., has children)
SmplValidationError	Validation error
SmplTimeoutError	Request timed out
SmplConnectionError	Network connectivity issue
SmplError	Any other SDK error

Debug Logging

Set SMPLKIT_DEBUG=1 to enable verbose diagnostic output to stderr. This is useful for troubleshooting real-time level changes, WebSocket connectivity, and SDK initialization. Debug output bypasses the managed logging framework and writes directly to stderr.

SMPLKIT_DEBUG=1 python my_app.py

Accepted values: 1, true, yes (case-insensitive). Any other value (or unset) disables debug output.

Documentation

• Getting Started
• Python SDK Guide
• API Reference

License

MIT