civisanalytics/civis-jupyter-python3

Civis Jupyter Notebook Python 3 Docker镜像

镜像概述与主要用途

该Docker镜像为Python 3环境提供自定义Jupyter Notebook，专为与Civis平台集成设计。它支持本地构建或从DockerHub获取，提供可重现的数据分析环境，适用于需要在本地测试Civis平台笔记本、开发数据科学项目的场景。

核心功能与特性

• 自定义Python 3环境：基于Jupyter Notebook构建，满足数据分析需求
• 版本化管理：支持通过标签（如latest或版本号1.0）获取特定版本，确保环境可重现
• Civis平台集成：可本地测试与Civis平台笔记本的交互，通过API Key实现身份验证
• 便捷部署：支持本地构建和DockerHub拉取，快速启动容器服务

使用场景与适用范围

• 本地开发和测试Civis平台笔记本
• 构建一致的数据分析环境，确保团队协作时环境统一
• 需要离线或本地运行Jupyter Notebook并同步Civis平台项目的场景

安装与使用方法

安装方式

本地构建镜像

bash
docker build -t civis-jupyter-python3 .

从DockerHub拉取镜像

bash
docker pull docker.xuanyuan.run/civisanalytics/civis-jupyter-python3:latest

标签说明：

• latest标签（默认）获取最新构建版本
• 可替换为具体版本号（如1.0）以获取可重现环境

与Civis平台集成测试

若需本地测试镜像与Civis平台的集成，请按以下步骤操作：

1. 获取Notebook ID：在Civis平台账号中创建笔记本，其ID为笔记本URL末尾的数字（格式：[***]）

2. 获取Civis API Key：从账号中生成API Key，参考生成Civis API Key的方法

3. 本地构建镜像：

   bash
   docker build -t civis-jupyter-python3 .
   

4. 运行容器：

   bash
   docker run --rm -p 8888:8888 -e PLATFORM_OBJECT_ID=<NOTEBOOK ID> -e CIVIS_API_KEY=$CIVIS_API_KEY civis-jupyter-python3
   

   注：假设环境变量$CIVIS_API_KEY已设置

5. 访问笔记本：通过Docker主机IP加端口8888访问，格式：<docker-host-ip>:8888

贡献指南

贡献流程

详见CONTRIBUTING文档。修改后需构建容器验证是否成功：

bash
docker build -t civis-jupyter-python3:test .

并在更新日志中描述变更内容。

维护者说明

• 本仓库启用自动构建：合并至master分支的PR会自动构建为DockerHub的latest标签
• 版本发布流程：
  1. 在仓库"releases"标签页点击"Draft a new release"
  2. 创建符合语义化版本的标签（格式：vX.X.X，即主版本.次版本.修订版本）
  3. 发布标题与标签一致，描述中包含更新日志
  4. 发布后DockerHub会自动构建三个标签：主版本、主版本.次版本、主版本.次版本.修订版本

许可

采用BSD-3许可协议，详见LICENSE.md。