emurcia/pivotable-be-py

📚 pivotable-be-py - Backend de Reportería para Pivotable.js

https://img.shields.io/docker/v/emurcia/pivotable-be-py/3.0?label=Docker%20Image&logo=docker](https://hub.docker.com/r/emurcia/pivotable-be-py) https://img.shields.io/badge/GitHub-GOES--DEV%2Fpivotable--be-blue?logo=github](https://github.com/GOES-DEV/pivotable-be)

---

🎯 Descripción del Proyecto

Este repositorio contiene la *** Docker para el servicio backend de la aplicación PIVOTABLE.

El backend está desarrollado en Python (utilizando el framework FastAPI) y su principal función es servir como intermediario para la reportería. Se conecta a BigQuery institucional (capa Gold del Data Warehouse) para ejecutar queries específicas. La data resultante es procesada y expuesta a la aplicación frontend (que utiliza pivotable.js) para la generación dinámica de reportes y tablas pivote.

• Repositorio GitHub Privado: https://github.com/GOES-DEV/pivotable-be

---

🚀 Uso y Despliegue con Docker Compose

La forma recomendada de levantar este servicio es utilizando Docker Compose, lo que facilita la gestión de las variables de entorno y la integración con otros servicios.

1. Requisitos Previos

Asegúrate de tener instalados:

• Docker
• Docker Compose
• El archivo de credenciales de Google Cloud (g-demo-dev-prj-e534-157dfd53f842.json) en el mismo contexto donde se ejecuta docker-compose.

2. Configuración de docker-compose.yml

Añade el siguiente servicio a tu archivo docker-compose.yml. Asegúrate de reemplazar los valores de ejemplo por tus configuraciones reales, especialmente el puerto (XXXX), versión de *** (X.X), nombre correcto de GCP_PROJECT_ID y las credenciales de la base de datos.

yaml
# Proyecto PIVOTABLE
pivotable-be-dev:
  # La imagen que se va a utilizar del Docker Hub
  image: emurcia/pivotable-be-py:X.X
  container_name: pivotable-be-dev
  # Asegura que el contenedor se reinicie automáticamente
  restart: always
  
  # Variables de Entorno Clave
  environment:
    # --- Configuración de Base de Datos (Si aplica) ---
    - DB_HOST=host_mysql
    - DB_PORT=port_mysql
    - DB_USER=user_mysql
    - DB_PASSWORD=pass_user_mysql
    - DB_NAME=db_mysql
    
    # --- Configuración de Seguridad (JWT) ---
    - JWT_SECRET_KEY=ExamPleAwB5sD-UZT0IACi-AbrKpqIBrqI1SNEw_av9iTNVFN-5wbTIp-3T9w544
    - ALGORITHM=HS256
    - ACCESS_TOKEN_EXPIRE_MINUTES=30
    
    # --- Configuración de Google Cloud / BigQuery ---
    - GCP_PROJECT_ID=g-xxxxxx-gold-prd-xxx-xxxx
    # Esta variable le indica al contenedor dónde buscar el archivo de credenciales
    - GOOGLE_APPLICATION_CREDENTIALS=g-demo-dev-prj-e534-157dfd53f842.json
    
  # Montar el archivo de credenciales de GCP dentro del contenedor
  # ¡Es vital para que el servicio acceda a BigQuery!
  volumes:
    - ./g-demo-dev-prj-e534-157dfd53f842.json:/app/g-demo-dev-prj-e534-157dfd53f842.json
    
  # Mapeo de Puertos: Mapea el puerto del host (XXXX) al puerto interno del contenedor (8080)
  ports:
    - "XXXX:8080"

3. Levantar el Servicio

Ejecuta el siguiente comando en el mismo directorio donde se encuentra tu archivo docker-compose.yml y el archivo de credenciales JSON:

bash
docker-compose up -d

Esto descargará la ***, creará y ejecutará el contenedor en segundo plano.

---

⚙️ Configuración (Variables de Entorno)

La aplicación utiliza las siguientes variables de entorno para su configuración. Deben ser definidas en docker-compose.yml o en un archivo .env referenciado.

---

🐳 Estructura de la ***

La *** está construida a partir de la *** base python:3.9-slim-buster y ejecuta la aplicación en el puerto 8080 bajo el comando uvicorn app.main:app. El usuario de ejecución dentro del contenedor es no-root por seguridad (appuser).