connect¶
Connect the process-default client to CloudSprite.
Supports two authentication modes: - API key (default): cs.connect(api_key="sk_...") - Cognito login: cs.connect(email="user@example.com", password="...")
Signature¶
connect(api_key: str | None=None, base_url: str | None=None, email: str | None=None, password: str | None=None, allow_insecure: bool=False) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
api_key |
str \| None |
no | None |
base_url |
str \| None |
no | None |
email |
str \| None |
no | None |
password |
str \| None |
no | None |
allow_insecure |
bool |
no | False |
Fields¶
| Field |
|---|
api_key |
base_url |
email |
password |
allow_insecure |
Return shape¶
None
Permission¶
This is a local SDK helper. It does not call the CloudSprite HTTP API.
Usage¶
cs.connect(api_key="sk_abc123")
cs.connect(email="engineer@company.com", password="secret")