Brightmarket Sync Guide

SDK overview

Core types and package exports.

Public exports from brightmarket_data_sync:

from brightmarket_data_sync import (
    BrightAPI,
    BrightmarketAdapter,
    BrightmarketConfig,
    ClientMappers,
    build_default_commands,
    mappers_from_constants,
    sync_clients,
    sync_skus,
    sync_tickets,
)
SymbolModuleRole
BrightAPIapiHTTP client (login, GET/POST/PUT/DELETE)
BrightmarketConfigconfigLoad API URL and credentials from env
BrightmarketAdaptercontractsProtocol your client adapter must implement
ClientMappers, sync_*, build_default_commandssyncRow → API sync orchestration

Package version: 2.4.0

Entity sync lives in brightmarket_data_sync.sync — see SDK sync. Writers live in brightmarket_data_sync.writers — see the Writers section.