ebasualdo/max-dashboard

Max Dashboard 镜像文档

镜像概述和主要用途

Max Dashboard是一个基于Python的仪表板应用Docker镜像，旨在提供便捷的本地构建、部署和运行流程。该镜像集成了Python虚拟环境管理、依赖安装（包括Bloomberg blpapi）、版本控制prehook脚本以及waitress服务器，适用于开发和部署轻量级仪表板应用。

核心功能和特性

• Python环境管理：支持创建和激活Python虚拟环境，隔离项目依赖
• 依赖管理：集成Bloomberg blpapi库及其他项目依赖的安装流程
• Docker本地构建：提供本地Docker镜像构建和运行命令，确保部署一致性
• 版本控制：包含pre-commit钩子脚本，自动更新requirements.txt和版本号（使用bump2version）
• 服务器支持：使用waitress作为WSGI服务器，提供稳定的HTTP服务

使用场景和适用范围

• 开发环境中快速搭建和测试仪表板应用
• 本地构建Docker镜像以验证部署可行性
• 需要版本控制和依赖管理的Python仪表板项目
• 集成Bloomberg blpapi数据的***相关仪表板应用

使用方法和配置说明

环境准备

创建Python虚拟环境

shell
python3 -m venv venv
source venv/bin/activate  # Linux/macOS
# Windows: venv\Scripts\activate

安装依赖

首先安装Bloomberg blpapi库：

shell
pip install --index-url=https://bcms.bloomberg.com/pip/simple/ blpapi

然后安装项目其他依赖：

shell
pip install -r requirements.txt

Docker镜像构建与测试

建议先在本地构建Docker镜像以验证部署可行性，避免直接推送无法构建的镜像到服务器：

构建本地镜像

bash
docker build -t dashboard:latest .

运行本地镜像

bash
docker run -t -p 9090:8080 --name dashboard dashboard:latest

• -t：分配伪终端
• -p 9090:8080：将容器内8080端口映射到主机9090端口
• --name dashboard：指定容器名称为dashboard

版本控制与提交

项目包含pre-commit钩子脚本，在执行git commit时自动完成以下操作：

• 更新requirements.txt（移除blpapi版本信息）
• 使用bump2version更新版本号（patch级别）
• 提交.bumpversion.cfg和requirements.txt文件

pre-commit钩子脚本内容如下：

shell
#!/bin/sh
pip freeze | sed 's/blpapi==.*//' > requirements.txt
bump2version patch --list --allow-dirty
git add .bumpversion.cfg requirements.txt

应用运行方式

直接使用Python运行

shell
python app/index.py

使用waitress服务器运行

shell
waitress-serve --listen=*:8080 app.index:app.server

• --listen=*:8080：监听所有网络接口的8080端口
• app.index:app.server：指定WSGI应用入口（模块:应用实例）