Python SDK Quickstart

pip install switchport

git clone https://github.com/switchport-ai/switchport-python.git
cd switchport-python
pip install -e .

from switchport import Switchport

# Initialize client (reads API key from environment)
client = Switchport()

# Execute a prompt
response = client.prompts.execute(
    prompt_key="welcome-message",
    variables={"name": "Alice"}
)

print("Generated text:")
print(response.text)
print(f"\nModel: {response.model}")
print(f"Version: {response.version_name}")

python test_switchport.py

Generated text:
Hello Alice! Welcome to our platform. We're excited to have you here!

Model: gpt-5
Version: v1

from switchport import Switchport

client = Switchport()

# Execute prompt with subject identification
response = client.prompts.execute(
    prompt_key="welcome-message",
    subject={"user_id": "user_123"},
    variables={"name": "Alice"}
)

# Simulate user feedback (1-5 stars)
user_rating = 4.5

# Record metric with same subject
result = client.metrics.record(
    metric_key="satisfaction",
    value=user_rating,
    subject={"user_id": "user_123"}  # Same context!
)

print(f"Metric recorded! Event ID: {result.metric_event_id}")