achauve/serenytics-python-client

Serenytics API Python客户端镜像

镜像概述

本Docker镜像为Serenytics API提供专用Python客户端环境，基于官方Python镜像构建，预安装Serenytics Python客户端库及必要依赖。用户可直接通过容器化方式与Serenytics平台交互，避免本地Python环境配置及依赖冲突问题，提升API集成效率。

核心功能与特性

• 预配置环境：内置Serenytics Python SDK及依赖库（如requests、python-dotenv），开箱即用
• 简化认证：支持通过环境变量快速配置API密钥，无需手动管理认证文件
• 版本兼容：基于Python 3.8+构建，兼容Serenytics API最新版本
• 轻量级设计：采用Alpine基础镜像，减少镜像体积，提升部署速度
• 可扩展性：支持自定义Python脚本挂载，满足复杂业务场景需求

使用场景与适用范围

适用场景

• 数据工程师通过API向Serenytics平台批量上传/更新数据
• 开发者自动化生成Serenytics报表或仪表盘
• 集成Serenytics工作流至CI/CD pipeline，实现数据处理自动化
• 测试环境快速验证Serenytics API功能及兼容性

适用人群

• 与Serenytics平台交互的后端开发者
• 需要自动化数据流程的数据工程师
• 构建Serenytics集成工具的技术团队

使用方法与配置说明

基本使用（docker run）

bash
docker run -it --rm \
  -e SERENYTICS_API_KEY="your_api_key_here" \
  -v $(pwd)/scripts:/app/scripts \
  serenytics-python-client:latest \
  python /app/scripts/your_script.py

参数说明

• -e SERENYTICS_API_KEY：必填，Serenytics平台API密钥（从Serenytics账户设置中获取）
• -v $(pwd)/scripts:/app/scripts：可选，挂载本地脚本目录至容器内，便于执行自定义Python脚本
• serenytics-python-client:latest：镜像名称及标签（请替换为实际使用的镜像版本）
• python /app/scripts/your_script.py：容器启动命令，执行指定Python脚本

环境变量配置

基础使用示例

1. 容器内直接执行API调用

bash
# 启动交互式容器
docker run -it --rm -e SERENYTICS_API_KEY="your_key" serenytics-python-client:latest python

# 在Python交互式终端中执行API调用
>>> from serenytics import SerenyticsClient
>>> client = SerenyticsClient(api_key=os.environ.get("SERENYTICS_API_KEY"))
>>> # 获取用户项目列表
>>> projects = client.get_projects()
>>> print(projects)

2. 运行本地脚本

1. 本地创建脚本文件 data_upload.py：

python
import os
from serenytics import SerenyticsClient

# 初始化客户端
client = SerenyticsClient(api_key=os.environ.get("SERENYTICS_API_KEY"))

# 示例：上传数据至Serenytics数据集
dataset_id = "your_dataset_id"
data = [{"id": 1, "value": "test_data"}, {"id": 2, "value": "sample"}]
response = client.upload_data(dataset_id, data)
print(f"数据上传结果: {response}")

2. 通过容器执行脚本：

bash
docker run -it --rm \
  -e SERENYTICS_API_KEY="your_api_key_here" \
  -v $(pwd)/data_upload.py:/app/data_upload.py \
  serenytics-python-client:latest \
  python /app/data_upload.py

高级配置

自定义依赖安装

如需添加额外Python依赖，可通过requirements.txt挂载并安装：

bash
docker run -it --rm \
  -v $(pwd)/requirements.txt:/app/requirements.txt \
  serenytics-python-client:latest \
  pip install -r /app/requirements.txt && python

持久化配置文件

将Serenytics配置文件（如.serenyticsrc）挂载至容器/root/.serenytics目录，实现配置持久化：

bash
docker run -it --rm \
  -v $(pwd)/.serenyticsrc:/root/.serenytics/.serenyticsrc \
  serenytics-python-client:latest