ignite-python-client

Apache Ignite轻量级（二进制协议）客户端，用Python 3编写。

先决条件

• Python 3.7或更高版本（已测试3.7、3.8、3.9、3.10和3.11），
• 访问Apache Ignite节点，本地或远程。当前的轻量级客户端版本已在Apache Ignite 2.14（二进制客户端协议1.7.0）上进行了测试。

安装

对于最终用户

如果您只想在项目中使用pyignite模块，请

$ pip install pyignite

对于开发者

如果您想运行测试、示例或构建文档，请克隆整个存储库

$ git clone git@github.com:apache/ignite-python-thin-client.git
$ pip install -e .

这将把pyignite存储库版本安装到您的环境中，所谓“开发”或“可编辑”模式。您可以在pip手册中了解更多关于可编辑安装的信息。

然后运行requirements文件夹中的内容，使用以下方法将附加要求安装到您的Python工作环境中

$ pip install -r requirements/<your task>.txt

您还可以参考setuptools手册了解如何使用setup.py。

可选的C扩展

有一个可选的C扩展，用于加速一些计算密集型任务。如果编译失败（缺少编译器或CPython头文件），则将不包含此模块安装pyignite。

• 在Linux或MacOS X上，只需要C编译器（gcc或clang）。它将在标准设置过程中进行编译。

• 为Linux构建通用wheel（二进制包），只需调用脚本./scripts/create_distr.sh。

  注意！需要Docker。

• 在Windows上需要MSVC 14.x，它应在路径中，还需要安装Python版本3.7、3.8、3.9、3.10和3.11，适用于x86和x86-64。您可以禁用其中一些版本，但需要编辑脚本。

• 为Windows构建wheel，使用PowerShell调用脚本.\scripts\BuildWheels.ps1。只需确保您的执行策略允许在您的环境中执行脚本。

  为不同Python版本（3.7、3.8、3.9和3.10）的x86和x86-64预制的wheel将位于distr目录中。

更新旧版本

要升级现有包，请使用以下命令

pip install --upgrade pyignite

安装包的最新版本

pip install pyignite

安装特定版本

pip install pyignite==0.6.1

文档

包文档可在RTD上方便地获取。

如果您想从源代码构建文档，请按照上述描述进行开发者安装，然后从客户端根目录运行以下命令

$ pip install -r requirements/docs.txt
$ cd docs
$ make html

然后在浏览器中打开docs/generated/html/index.html。

示例

在examples文件夹中提供了pyignite的一些使用示例。它们在“使用示例”部分中进行了广泛注释。

此代码意味着它在已安装pyignite包的环境中运行，Apache Ignite节点在本地主机：10800上运行。

测试

注意！建议以开发模式安装pyignite。有关说明，请参阅本节。

不要忘记安装测试需求

$ pip install -r requirements/install.txt -r requirements/tests.txt

此外，您还需要具有启用了log4j2的Ignite二进制发布版本，并设置IGNITE_HOME环境变量

$ cd <ignite_binary_release>
$ export IGNITE_HOME=$(pwd)
$ cp -r $IGNITE_HOME/libs/optional/ignite-log4j2 $IGNITE_HOME/libs/

运行基本测试

$ pytest

使用示例运行

$ pytest --examples 

如果您需要更改连接参数，请参阅测试文档。