promptops-sdk 0.1.0

Python SDK for PromptOps - AI Prompt Management Platform

PromptOps Python SDK

Python SDK for PromptOps — AI Prompt Management Platform.

Installation

pip install promptops

Quick Start

from promptops import PromptOps

po = PromptOps(api_key="pop_sk_xxx")
config = po.get_prompt("customer-support", label="prod")
print(config.system_prompt)

# Context manager (recommended — ensures cleanup)
with PromptOps(api_key="pop_sk_xxx") as po:
    config = po.get_prompt("customer-support")
    print(config.system_prompt)

Variable Substitution

from promptops import PromptOps

with PromptOps(api_key="pop_sk_xxx") as po:
    config = po.get_prompt("customer-support")

    if config.user_prompt_template:
        message = PromptOps.substitute(
            config.user_prompt_template,
            {"customer_name": "Alice", "issue": "login problem"},
        )
        print(message)

Configuration Options

from promptops import PromptOps, PromptConfig

# Fallback used when API is unreachable and cache is empty
fallback_config = PromptConfig(
    slug="customer-support",
    version=1,
    type="text",
    system_prompt="You are a helpful assistant.",
    user_prompt_template="Help {{customer_name}} with: {{issue}}",
    content=None,
    config={"model": "gpt-4o-mini", "provider": "openai", "temperature": 0.7, "max_tokens": 1024},
    variables=[{"name": "customer_name"}, {"name": "issue"}],
    updated_at="2024-01-01T00:00:00Z",
)

po = PromptOps(
    api_key="pop_sk_xxx",
    base_url="https://promptsops.com",   # default
    refresh_interval=60,                  # seconds, default 60
    fallback={"customer-support": fallback_config},
)

Manual Cache Refresh

with PromptOps(api_key="pop_sk_xxx") as po:
    # Refresh a specific prompt
    po.refresh("customer-support")

    # Refresh all cached prompts
    po.refresh()

PromptConfig Fields

Field	Type	Description
slug	str	Prompt identifier
version	int	Prompt version number
type	str	"text" or "chat"
system_prompt	str | None	System prompt text
user_prompt_template	str | None	User prompt with {{variable}} placeholders
content	Any	Chat-type structured content
config	dict	Model config: model, provider, temperature, max_tokens
variables	list[dict]	Variable definitions: name, optional description
updated_at	str	ISO 8601 timestamp of last update

Caching Behaviour

The SDK uses a 3-tier fallback strategy on every get_prompt() call:

1. In-memory cache — returns immediately if the entry is younger than refresh_interval seconds.
2. API fetch — sends a request with If-None-Match (ETag); a 304 Not Modified response refreshes the timestamp without re-parsing the body.
3. User-provided fallback — returned when both the cache and API are unavailable.

A background daemon thread automatically refreshes all cached prompts every refresh_interval seconds. The cache is protected by a threading.Lock and is safe for concurrent use.

License

Apache-2.0