OpenRefine Python 客户端库技术文档

1. 安装指南

1.1 依赖安装

首先，确保你已经安装了 pip。如果没有安装，请先安装 pip。然后，使用以下命令安装项目所需的依赖：

sudo pip install -r requirements.txt

1.2 配置 OpenRefine 服务器

默认情况下，OpenRefine 服务器的 URL 是 http://127.0.0.1:3333。你可以通过设置环境变量 OPENREFINE_HOST 和 OPENREFINE_PORT 来覆盖默认的主机和端口。

1.3 运行测试、构建和安装

在安装依赖并配置好 OpenRefine 服务器后，你可以运行以下命令来测试、构建和安装项目：

python setup.py test  # 运行测试
python setup.py build  # 构建项目
python setup.py install  # 安装项目

你也可以使用 Makefile 来自动完成这些步骤。

2. 项目的使用说明

OpenRefine Python 客户端库提供了一个与 OpenRefine 服务器通信的接口。你可以使用该库来执行以下操作：

• 项目的创建、导入、删除和导出
• 分面计算（如文本、数字、空白、星标等）
• 排序和重新排序
• 聚类
• 转换和转置
• 单次和批量编辑
• 注释（星标/标记）
• 列操作（移动、添加、拆分、重命名、重新排序、删除）
• 数据调和（如调和判断分面、猜测列类型、查询调和服务偏好、执行调和）

3. 项目 API 使用文档

3.1 项目操作

你可以使用以下 API 来管理 OpenRefine 项目：

• 创建/导入项目：通过指定文件路径或 URL 来创建或导入项目。
• 删除项目：通过项目 ID 删除项目。
• 导出项目：将项目导出为指定格式的文件。

3.2 分面计算

分面计算是 OpenRefine 的核心功能之一。你可以使用以下 API 来计算不同类型的分面：

• 文本分面：基于文本内容的分面。
• 数字分面：基于数字内容的分面。
• 空白分面：基于空白内容的分面。
• 星标和标记分面：基于星标和标记的分面。

3.3 列操作

你可以使用以下 API 来管理列：

• 移动列：将列移动到指定位置。
• 添加列：基于现有列添加新列。
• 拆分列：将列拆分为多个列。
• 重命名列：重命名指定列。
• 重新排序列：重新排列列的顺序。
• 删除列：删除指定列。

3.4 数据调和

数据调和是 OpenRefine 的一个重要功能，你可以使用以下 API 来执行调和操作：

• 调和判断分面：基于调和结果的分面。
• 猜测列类型：自动猜测列的数据类型。
• 查询调和服务偏好：查询调和服务的偏好设置。
• 执行调和：执行数据调和操作。

4. 项目安装方式

4.1 使用 pip 安装

你可以使用 pip 来安装 OpenRefine Python 客户端库：

pip install refine-client-py

4.2 从源码安装

你也可以从源码安装该项目：

1. 克隆项目仓库：

   git clone https://github.com/PaulMakepeace/refine-client-py.git
   

2. 进入项目目录：

   cd refine-client-py
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 构建并安装项目：

   python setup.py build
   python setup.py install
   

通过以上步骤，你可以成功安装并使用 OpenRefine Python 客户端库。