NexusClient

from nexus import NexusClient

The Nexus client — one object, every Nexus product.

from nexus import NexusClient

nexus = NexusClient("nxs_live_xxx")
nexus.identify("user_123", email="a@b.com")
nexus.events.track("order_placed", {"total": 42})
nexus.realtime.emit("orders:42", "status", {"state": "shipped"})

The client is thread-safe and meant to be built once per process and shared. In a web app, build it at import time (or in your framework's startup hook) and reuse it; the integrations in nexus.integrations do that for you.

NexusClientCopy Anchor Link

A configured connection to one Nexus environment.

NexusClientCopy Anchor Link

NexusClient(api_key=None, *, config=None, transport=None, dispatcher=None, **options)

Parameters

distinct_idCopy Anchor Link

distinct_id: Optional[str]

The user bound to the current context, if any.

session_keyCopy Anchor Link

session_key: Optional[str]

The session bound to the current context, if any.

pendingCopy Anchor Link

pending: int

How many buffered items are waiting to be sent.

closedCopy Anchor Link

closed: bool

identify()Copy Anchor Link

def identify(distinct_id, *, email=None, name=None, phone=None, traits=None, remote=True, **context_fields) -> Dict[str, Any]

Set the current user locally and upsert them server-side.

Pass remote=False to only bind the local context (useful in a hot loop where the person already exists).

Parameters

Returns Dict[str, Any]

reset()Copy Anchor Link

def reset() -> None

Forget the user and start a new session — call this on logout.

current_distinct_id()Copy Anchor Link

def current_distinct_id() -> Optional[str]

Returns Optional[str]

ambient_properties()Copy Anchor Link

def ambient_properties() -> Mapping[str, Any]

Properties bound via nexus.context.scope.

Returns Mapping[str, Any]

resolve_context()Copy Anchor Link

def resolve_context(**overrides) -> Dict[str, Any]

Merge config defaults, ambient context and explicit overrides.

Keys are the API's camelCase field names. Precedence, lowest first: client config → nexus.context → overrides.

Parameters

Returns Dict[str, Any]

request()Copy Anchor Link

def request(request) -> Any

Execute one partner-API request.

Raises a nexus.exceptions.NexusError subclass on failure, unless the client is configured silent=True — then it logs and returns None.

Parameters

Returns Any

enabled()Copy Anchor Link

def enabled(service) -> bool

Whether a product is switched on — services / NEXUS_<SERVICE>_ENABLED.

Parameters

Returns bool

enqueue_event()Copy Anchor Link

def enqueue_event(item, context) -> None

Buffer one event (or send it now when batching is off).

Parameters

enqueue_log()Copy Anchor Link

def enqueue_log(item, context) -> None

Buffer one log line (or send it now when batching is off).

Parameters

flush_events()Copy Anchor Link

def flush_events(timeout=None) -> None

Parameters

flush_logs()Copy Anchor Link

def flush_logs(timeout=None) -> None

Parameters

flush()Copy Anchor Link

def flush(timeout=None) -> None

Ship every buffered event and log line, and drain any background dispatcher. Call it before a short-lived process exits (the SDK also does this at interpreter exit).

Parameters

with_dispatcher()Copy Anchor Link

def with_dispatcher(dispatcher) -> 'NexusClient'

A sibling client that delivers through a different dispatcher.

The two share nothing but configuration, so buffering and shutdown stay independent.

Parameters

Returns 'NexusClient'

background()Copy Anchor Link

def background(*, workers=1) -> 'NexusClient'

A sibling client where every call is fire-and-forget.

bg = nexus.background()
bg.push.send_to_user("u_1", title="Welcome")   # returns None

Result-returning calls (flags, Remote Config) can't work here — use the normal client for those.

Parameters

Returns 'NexusClient'

track()Copy Anchor Link

def track(name, properties=None, **kwargs) -> None

Shortcut for client.events.track.

Parameters

capture_exception()Copy Anchor Link

def capture_exception(exc=None, **options) -> Dict[str, Any]

Shortcut for client.errors.capture_exception.

Parameters

Returns Dict[str, Any]

emit()Copy Anchor Link

def emit(room, events, payload=None) -> Dict[str, Any]

Shortcut for client.realtime.emit.

Parameters

Returns Dict[str, Any]

is_enabled()Copy Anchor Link

def is_enabled(key, distinct_id=None, **kwargs) -> bool

Shortcut for client.flags.is_enabled.

Parameters

Returns bool

close()Copy Anchor Link

def close(timeout=3.0) -> None

Flush and release everything. Idempotent.

Parameters