Python Client for Axon Server

本软件包提供了一个用于Axon Server的Python客户端。

安装

使用pip从Python包索引安装稳定版本。

$ pip install axonserver

请注意，建议将Python包安装到Python虚拟环境中。

入门指南

启动一个 Axon Server。

$ docker run -d --name my-axon-server -p 8024:8024 -p 8124:8124 axoniq/axonserver axonserver

使用包含您的Axon Server的主机和端口号的 uri 构造 AxonClient 类。

from axonclient.client import AxonClient

axon_client = AxonClient(uri='localhost:8024')

调用客户端方法在Axon Server中添加和列出事件。

有关使用示例，请参阅 Python eventsourcing extension project for Axon Server。

开发者

在克隆axonclient仓库后，在根目录中运行以下命令设置虚拟环境并安装依赖项。

$ make install

make install 命令使用构建工具Poetry为此项目创建一个专用的Python虚拟环境，并安装Black、isort和pytest等流行的开发依赖项。

在 ./tests 中添加测试。在 ./axonclient 中添加代码。

运行测试。

$ make test

检查代码格式。

$ make lint

重新格式化代码。

$ make fmt

在 pyproject.toml 中添加依赖项，然后更新已安装的包。

$ make update-packages