Configuration

Generated from the SDK's own /docs/ — also served raw at https://shipeasy-ai.github.io/sdk-python/pages/configuration.md.

`configure(...)` — the once-per-process call

import shipeasy

shipeasy.configure(
    api_key="sdk_server_...",
    attributes=lambda u: {"user_id": u.id, "country": u.country, "plan": u.plan},
)

api_key — your Shipeasy server key (sdk_server_...). Authenticates flags, configs, kill switches and experiments. Never embed it in a browser.

attributes — a transform from YOUR user object to the Shipeasy attribute map that targeting evaluates against. The default is identity, so if your user object is already that map you can omit it:

shipeasy.configure(api_key="sdk_server_...")
# construct once per callsite (cheap; binds the user)
client = shipeasy.Client({"user_id": "u_123", "country": "US"})
client.get_flag("new_checkout")

configure() is first-config-wins: the first call wires everything up; later calls are a no-op. By default it kicks off a one-shot fetch fire-and-forget, so the first Client(user).get_flag(...) resolves against real rules.

Identity default

The attribute map you produce is the unit of identity — supply user_id for logged-in users, or let the anon-id middleware inject anonymous_id for logged-out traffic. An explicit user_id/anonymous_id always wins.

One-shot vs background poll

default (init=True) — a one-shot fetch. Ideal for serverless / short-lived processes.
poll=True — start the background poll (initial fetch + periodic refresh) for a long-running server, so flags stay fresh without a redeploy. Configuration owns the lifecycle; you never touch a lower-level object:

shipeasy.configure(api_key="sdk_server_...", poll=True)

`configure()` options

Any of these pass straight through configure(...) as keyword arguments:

keyword	type	default	what it does
`attributes`	`Callable`	identity	YOUR user object → the Shipeasy attribute map.
`init`	`bool`	`True`	Fire the one-shot fetch fire-and-forget.
`poll`	`bool`	`False`	Start the background poll (refreshes the blob over time).
`base_url`	`str`	`https://api.shipeasy.ai`	API base URL for the blobs. Override for a self-hosted edge or in tests.
`env`	`str`	`"prod"`	Deployment environment tag, attached to `see()` error events and usage telemetry.
`disable_telemetry`	`bool`	`False`	Opt out of per-evaluation usage telemetry. Evaluation itself is unaffected.
`telemetry_url`	`str`	built-in	Override the telemetry endpoint (rarely needed).
`private_attributes`	`Sequence[str]`	`[]`	Attribute keys stripped from every outbound event before it leaves the process. They still drive targeting locally. See advanced.
`sticky_store`	`StickyBucketStore`	`None`	Pin a user's experiment group across re-buckets. See advanced.

Tests and offline

For unit tests and offline evaluation, use the drop-in siblings of configure() — configure_for_testing / configure_for_offline. They take the same attributes transform (and override args), skip the api key, and let shipeasy.Client(user) read without ever touching the network.

Was this page helpful?

✎ Edit this page