Inicio rápido

Instalar el SDK en tu proyecto, configurar credenciales y verificar conectividad.

Trabajá dentro del proyecto que recibiste de Brightmarket o descargaste en Obtener tu proyecto.

1. Credenciales CodeArtifact (primero)

Sin esto no podés instalar brightmarket-data-sync. Tu administrador te entrega credenciales IAM de lectura (bgmkt-codeartifact-reader).

cp login_aws.env.example login_aws.env   # completar keys

2. Entorno virtual e instalación

Requisitos: AWS CLI v2 en PATH, login_aws.env completado (paso 1), venv activo.

Detalle completo: Autenticación pip.

python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate

Autenticá pip contra CodeArtifact (token ~12 h):

# Linux / macOS / Git Bash
./scripts/auth-pip.sh

# Windows PowerShell
.\scripts\auth-pip-win.ps1

REM Windows CMD
scripts\auth-pip-win.cmd

pip install -r requirements.txt

Tu requirements.txt ya incluye el pin del SDK, por ejemplo:

brightmarket-data-sync==X.Y.Z
pyodbc==5.2.0
python-dotenv==1.0.1
tqdm==4.67.0

Si pip install devuelve 401, volvé a ejecutar el script de auth (auth-pip.sh, auth-pip-win.ps1 o auth-pip-win.cmd).

3. Variables de entorno

cp .env.example .env

Variable	Quién la usa	Descripción
`API_URL_BRIGHT`	SDK	URL base de la API
`USER_EMAIL_BRIGHT`	SDK	Email del usuario Brightmarket
`USER_PASSWORD_BRIGHT`	SDK	Contraseña
`USER_ORG_BRIGHT`	SDK	Organización
`DB_*`	Tu proyecto	Conexión a tu fuente de datos
`BUSINESS_UNIT_ID`	Tu proyecto	Business unit en Brightmarket

El SDK solo lee las variables *_BRIGHT. El runner CLI del SDK carga .env al inicio del proceso.

4. Verificar instalación

python -c "import brightmarket_data_sync; print(brightmarket_data_sync.__file__)"
python -m src.main -test

-test verifica conexión a tu BD y login en la API Brightmarket sin sincronizar datos.

5. Usar la CLI

La forma recomendada en proyectos cliente es mantener el entrypoint compatible:

python -m src.main -clients
python -m src.main -tickets -from 20260101 -to 20260131
python -m src.main -tickets -file -from 20260101 -to 20260131

src/main.py delega al runner del SDK y src/sync_registry.py define qué flags existen en tu cliente. -tickets -file genera un JSONL y lo sube al import; sin -file envía un ticket por request.

El SDK también instala un comando directo para casos avanzados:

brightmarket-sync --registry src.sync_registry -tickets -from 20260101 -to 20260131

Próximo paso

Guía de implementación — implementar adapter y módulos sync.