greatexpectations/jupyter

Great Expectations Jupyter Notebook 环境镜像

镜像概述

本镜像提供了一个预配置的集成环境，将数据验证工具Great Expectations与交互式开发环境Jupyter Notebook相结合，旨在简化数据团队的数据质量保障工作。用户可直接在Jupyter Notebook中创建、测试和维护数据验证规则（Expectations），同时利用Notebook的交互式特性进行数据探索、结果可视化及报告生成。

核心功能与特性

• 开箱即用的集成环境：预安装Great Expectations和Jupyter Notebook，无需手动配置依赖，启动即可使用
• 数据验证全流程支持：覆盖数据验证规则的定义、测试、执行与结果分析全生命周期
• 交互式开发体验：通过Jupyter Notebook界面实现代码编写、数据探索与验证结果实时可视化
• 多数据源兼容：支持Great Expectations原生兼容的各类数据源（CSV、Parquet、SQL数据库、Spark等）
• 报告与文档化：可直接导出数据验证报告（HTML/PDF格式）及Notebook文档，便于团队共享与审计

使用场景与适用范围

适用场景

• 数据工程师构建数据管道时的质量监控规则开发与调试
• 数据分析师在数据探查阶段验证数据集完整性与一致性
• 数据科学家建模前检查输入数据质量，确保模型训练数据可靠性
• 团队协作开发数据验证标准，统一数据质量基线
• 教学或培训中演示数据验证最佳实践与工具使用方法

适用人群

• 数据工程师、数据分析师、数据科学家等数据团队成员
• 需要保障数据质量的中小型数据团队
• 希望标准化数据验证流程的企业或组织

使用方法与配置说明

基本使用（Docker Run）

通过以下命令启动容器，映射本地目录至容器内工作区，并设置访问密码：

bash
docker run -d \
  -p 8888:8888 \
  -v $(pwd)/workspace:/home/jovyan/work \  # 本地目录挂载至容器工作区
  -v $(pwd)/gx_config:/home/jovyan/great_expectations \  # 持久化Great Expectations配置
  -e JUPYTER_TOKEN="your_secure_token" \  # Jupyter访问密码
  --name gx-jupyter-env \
  [镜像名称]  # 替换为实际镜像名称

容器启动后，通过浏览器访问 http://localhost:8888，输入设置的 JUPYTER_TOKEN 即可进入Jupyter Notebook界面。

Docker Compose 配置示例

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3'
services:
  gx-jupyter:
    image: [镜像名称]  # 替换为实际镜像名称
    ports:
      - "8888:8888"
    volumes:
      - ./workspace:/home/jovyan/work  # 工作区目录（存放Notebook文件）
      - ./gx_config:/home/jovyan/great_expectations  # Great Expectations配置目录
      - ./data:/home/jovyan/data  # 数据文件挂载（可选）
    environment:
      - JUPYTER_TOKEN=your_secure_token  # 必选，Jupyter访问密码
      - GX_HOME=/home/jovyan/great_expectations  # Great Expectations配置路径（默认值）
      - PORT=8888  # Jupyter服务端口（默认值）
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

核心配置参数

典型工作流示例

1. 启动容器：通过上述 docker run 或 docker-compose 命令启动环境
2. 创建Notebook：在Jupyter界面新建Notebook，导入Great Expectations：

   python
   import great_expectations as gx
   from great_expectations.dataset import PandasDataset
   

3. 定义数据验证规则：加载数据并创建Expectations：

   python
   # 加载数据
   df = pd.read_csv("/home/jovyan/work/data/sample_data.csv")
   dataset = PandasDataset(df)
   
   # 定义验证规则（示例：检查"user_id"列非空）
   dataset.expect_column_values_to_not_be_null("user_id")
   

4. 执行验证并查看结果：

   python
   result = dataset.validate()
   print(result)  # 打印验证结果
   

5. 导出报告：通过Great Expectations导出HTML报告：

   python
   context = gx.get_context()
   context.build_data_docs()  # 生成数据文档（默认在GX_HOME/uncommitted/data_docs中）
   

注意事项

• 本地挂载目录需确保读写权限，避免容器内权限不足导致文件操作失败
• Great Expectations配置文件（如great_expectations.yml）建议通过挂载持久化，避免容器重建后配置丢失
• 生产环境使用时，建议通过环境变量或密钥管理工具安全存储JUPYTER_TOKEN等敏感信息
• 如需扩展数据源支持（如特定数据库驱动），可通过Dockerfile基于本镜像添加依赖或直接在容器内安装