Introducción
Qué implementás en tu proyecto y qué resuelve el SDK de Brightmarket.
Esta documentación es para equipos que implementan la sincronización de datos de su organización hacia Brightmarket.
El SDK brightmarket-data-sync es una librería Python (paquete pip) que escribe en la API de Brightmarket. Tu proyecto implementa la lectura desde tu fuente (base de datos, CSV, API, etc.) y la transformación a los formatos que esperan los writers del SDK.
Requisitos
- Python 3.8+ — el SDK y tu proyecto cliente se ejecutan en Python. Creá un entorno virtual antes de instalar dependencias (Inicio rápido).
Qué implementás vos
| Capa | Tu responsabilidad | Archivo típico |
|---|---|---|
| Adapter | Leer tu BD/vistas/archivos; filtros por fecha | src/adapter.py |
| Sync | Transformar filas → payloads; orquestar writers | src/sync/*.py |
| CLI / ops | Flags, logging, Docker, CI | src/main.py |
Qué resuelve el SDK (no lo dupliques)
| Capa | Responsabilidad |
|---|---|
| SDK | Login HTTP, writers (POST/PUT a Brightmarket) |
Regla: nunca copies BrightAPI ni lógica de escritura HTTP. Importá siempre desde brightmarket_data_sync.
Flujo de datos
Tu fuente de datos (BD, vistas, archivos, API)
↓
ClientAdapter (src/adapter.py)
↓
sync/* (transformación por entidad)
↓
brightmarket_data_sync.writers → API BrightmarketPor dónde empezar
- Obtener tu proyecto — entrega de Brightmarket o descarga del template
- Inicio rápido — instalar SDK desde CodeArtifact
- Guía de implementación — adapter, sync, pruebas
- Estructura del proyecto — referencia archivo por archivo
- Referencia del SDK —
BrightmarketAdapter, writers, config
Para los endpoints REST subyacentes: documentación de la API REST.