Obtener tu proyecto
Cómo recibir o descargar el proyecto base para implementar tu sincronización.
Antes de instalar el SDK, necesitás un proyecto cliente con la estructura de archivos, stubs de código y requirements.txt con la versión del SDK.
Opción A — Entrega por Brightmarket (recomendada)
Tu contacto de onboarding en Brightmarket puede entregarte:
- Un repositorio privado, o
- Un archivo zip
con nombre brightmarket-<tu-org>-sync, que ya incluye:
| Archivo / carpeta | Para qué sirve |
|---|---|
requirements.txt | Pin de brightmarket-data-sync y dependencias |
login_aws.env.example | Plantilla para credenciales reader de CodeArtifact |
.env.example | Plantilla para BD y API Brightmarket |
scripts/auth-pip.sh | Autenticar pip contra CodeArtifact |
src/adapter.py | Stubs del protocolo de lectura |
src/sync/*.py | Stubs de transformación por entidad |
src/main.py | CLI con flags -test, -clients, etc. |
Seguí con Inicio rápido dentro de ese proyecto.
Opción B — Descarga del template
Si aún no tenés un proyecto entregado, podés descargar el template base (se genera en cada build de esta documentación, con el pin del SDK de esa versión):
Descargar brightmarket-client-starter-1.1.13.zipDocumentación: v1.1.13 · 7cf22f4 · SDK 1.1.13. El zip del template incluye brightmarket-data-sync==1.1.13.
Después de descomprimir:
- Renombrá la carpeta a
brightmarket-<tu-org>-sync(convención recomendada) - Inicializá git si lo necesitás
- Seguí Inicio rápido
El zip incluye la versión actual del SDK en requirements.txt. No necesitás acceso al repositorio interno del SDK.
Qué NO tenés que hacer
- No necesitás clonar ni editar el repositorio del SDK
- No publicás tu proyecto como paquete pip: es una aplicación que consume
brightmarket-data-sync
Próximo paso
Inicio rápido — instalar dependencias, configurar .env y probar con -test.