Skip to content

README.md

Latest commit

 

History

History
58 lines (42 loc) · 1.29 KB

README.md

File metadata and controls

58 lines (42 loc) · 1.29 KB
Raw

convert-python-sdk

This repository currently contains the Story 1.1 scaffold for Convert's Python SDK.

Canonical package decisions frozen in this story:

  • Distribution name: convert-python-sdk
  • Import package: convert_sdk
  • Stable public imports: Core, Context, and __version__

The scaffold is intentionally minimal. Feature initialization, configuration loading, local evaluation, and tracking behavior will land in later stories.

Local Development

UV_CACHE_DIR=/tmp/uv-cache uv sync --group dev
UV_CACHE_DIR=/tmp/uv-cache uv run pytest
UV_CACHE_DIR=/tmp/uv-cache uv build

Public Import Boundary

from convert_sdk import Context, Core, __version__

Initialization

Initialize with direct config data:

from convert_sdk import Core, SDKConfig

project_config = {
    "account_id": "1001",
    "project": {"id": "2002", "name": "Demo"},
}

core = Core(SDKConfig(config_data=project_config))
assert core.is_ready

Initialize with an SDK key:

from convert_sdk import Core, SDKConfig, TransportConfig

core = Core(
    SDKConfig(
        sdk_key="1001/2002",
        environment="staging",
        transport=TransportConfig(
            config_endpoint="https://cdn-4.convertexperiments.com/api/v1",
        ),
    )
)
assert core.is_ready