Variables de entorno
BCN Extractor se configura mediante un archivo .env en la raíz del proyecto. Copia .env.example como punto de partida:
cp .env.example .envBase de datos
Section titled “Base de datos”| Variable | Requerida | Default | Descripción |
|---|---|---|---|
DB_HOST | ✅ | localhost | Host de PostgreSQL |
DB_PORT | ✅ | 5432 | Puerto de PostgreSQL |
DB_NAME | ✅ | bcn_extractor | Nombre de la base de datos |
DB_USER | ✅ | postgres | Usuario de PostgreSQL |
DB_PASSWORD | ✅ | — | Contraseña de PostgreSQL |
# .env — configuración de base de datosDB_HOST=localhostDB_PORT=5432DB_NAME=bcn_extractorDB_USER=postgresDB_PASSWORD=tu_password_seguraBCN Client
Section titled “BCN Client”| Variable | Requerida | Default | Descripción |
|---|---|---|---|
BCN_RATE_LIMIT | — | 1.0 | Segundos de espera entre requests a la BCN |
BCN_MAX_RETRIES | — | 3 | Número máximo de reintentos por request fallido |
BCN_TIMEOUT | — | 30 | Timeout en segundos por request |
# .env — configuración del cliente BCNBCN_RATE_LIMIT=1.0BCN_MAX_RETRIES=3BCN_TIMEOUT=30Rutas de almacenamiento
Section titled “Rutas de almacenamiento”| Variable | Default | Descripción |
|---|---|---|
XML_PATH | ./data/xml | Directorio donde se guardan los XMLs descargados |
MD_PATH | ./data/md | Directorio donde se guardan los Markdowns generados |
LOG_PATH | ./data/logs | Directorio de archivos de log |
CACHE_PATH | ./data/cache | Directorio de caché |
| Variable | Default | Descripción |
|---|---|---|
API_HOST | 0.0.0.0 | Host donde escucha la API |
API_PORT | 8000 | Puerto de la API |
API_RELOAD | false | Habilitar recarga automática (solo desarrollo) |
# .env — para desarrollo localAPI_HOST=127.0.0.1API_PORT=8000API_RELOAD=trueEjemplo completo de .env
Section titled “Ejemplo completo de .env”# ─── Base de datos ─────────────────────────DB_HOST=localhostDB_PORT=5432DB_NAME=bcn_extractorDB_USER=postgresDB_PASSWORD=cambia_esto_por_algo_seguro
# ─── BCN Client ────────────────────────────BCN_RATE_LIMIT=1.0BCN_MAX_RETRIES=3BCN_TIMEOUT=30
# ─── Rutas ─────────────────────────────────XML_PATH=./data/xmlMD_PATH=./data/mdLOG_PATH=./data/logsCACHE_PATH=./data/cache
# ─── API ───────────────────────────────────API_HOST=0.0.0.0API_PORT=8000API_RELOAD=false