SDK Upgrade Guide: v0.6.0 → v0.6.1¶

# In your requirements.txt or pyproject.toml
swisper-studio-sdk>=0.6.1

pip install swisper-studio-sdk==0.6.1

# ✅ This still works exactly the same
from swisper_studio_sdk import auto_trace

async def startup():
    status = await auto_trace()
    print(f"Tracing enabled: {status['enabled']}")

from swisper_studio_sdk import auto_trace

async def startup():
    status = await auto_trace()  # status is 'Any' - no IDE help

from swisper_studio_sdk import auto_trace, AutoTraceStatus

async def startup():
    status: AutoTraceStatus = await auto_trace()
    # Now your IDE knows:
    #   status['enabled']: bool
    #   status['redis']: bool
    #   status['langgraph_patched']: bool
    #   etc.

from swisper_studio_sdk import (
    # Status types
    InitializationStatus,  # Return type of safe_initialize()
    AutoTraceStatus,       # Return type of auto_trace()
    TracingConfig,         # Configuration options

    # Literal types
    ObservationType,       # "AUTO" | "SPAN" | "GENERATION" | "TOOL" | "AGENT"
)

DeprecationWarning: initialize_tracing is deprecated. Use safe_initialize or auto_trace instead.

from swisper_studio_sdk import initialize_tracing

# Old API - still works but deprecated
result = initialize_tracing(
    api_url="http://localhost:8000",
    project_id="my-project",
    api_key="my-key"
)

from swisper_studio_sdk import auto_trace

# One-line initialization - reads from environment
status = await auto_trace()

from swisper_studio_sdk import safe_initialize

# Explicit configuration
status = await safe_initialize(
    redis_url="redis://redis:6379",
    project_id="my-project"
)

# Required
SWISPER_STUDIO_PROJECT_ID=your-project-id

# Optional (defaults shown)
SWISPER_STUDIO_REDIS_URL=redis://redis:6379
SWISPER_STUDIO_STREAM_NAME=observability:events
SWISPER_STUDIO_ENABLED=true

class AutoTraceStatus(TypedDict):
    enabled: bool           # Overall tracing status
    initialized: bool       # SDK initialized
    redis: bool            # Redis connected
    write: bool            # Can write to stream
    consumer: bool         # Consumer verified
    langgraph_patched: bool # LangGraph auto-instrumented
    llm_wrapper: bool      # LLM wrapper active
    environment: Optional[str]  # Environment name
    error: Optional[str]   # Error message if any

class InitializationStatus(TypedDict):
    enabled: bool      # Tracing enabled
    redis: bool        # Redis connected
    write: bool        # Can write events
    consumer: bool     # Consumer running
    initialized: bool  # Fully initialized

ObservationType = Literal["AUTO", "SPAN", "GENERATION", "TOOL", "AGENT"]

python -c "
from swisper_studio_sdk import __version__, AutoTraceStatus
print(f'SDK Version: {__version__}')
print(f'Type exports available: AutoTraceStatus = {AutoTraceStatus}')
"

SDK Version: 0.6.1
Type exports available: AutoTraceStatus = <class 'swisper_studio_sdk._types.AutoTraceStatus'>