Matrix的客户端服务器sdk
matrix-client的Python项目详细描述
用于python的matrix客户端sdk
这是一个用于python 2.7和3.4+的matrix客户机服务器sdk
社区讨论这个sdk的使用和这个sdk的开发可以 在#matrix-python-sdk:matrix.org找到。
安装
稳定释放
使用来自pypi的pip安装。这也将安装所有必要的依赖项。
pip install matrix_client
开发版本
使用根项目目录中的setup.py安装。这也将安装所有 需要依赖关系。
git clone https://github.com/matrix-org/matrix-python-sdk.git
cd matrix-python-sdk
python setup.py install
用法
sdk提供了两层交互。低层只是包裹 原始http api调用。高级层包装低级层，并提供 要对其执行操作的对象模型。
客户：
frommatrix_client.clientimportMatrixClientclient=MatrixClient("http://localhost:8008")# New usertoken=client.register_with_password(username="foobar",password="monkey")# Existing usertoken=client.login_with_password(username="foobar",password="monkey")room=client.create_room("my_room_alias")room.send_text("Hello!")
API:
frommatrix_client.apiimportMatrixHttpApimatrix=MatrixHttpApi("https://matrix.org",token="some_token")response=matrix.send_message("!roomid:matrix.org","Hello!")
结构
sdk分为两个模块：api和client。
api
它包含原始的http api调用，并且具有最小的业务逻辑。你可以 设置用于请求的访问令牌（token）以及设置自定义 事务ID（txn_id），将为每个请求递增。
客户
它封装了api模块并提供了诸如Room之类的对象模型。
样品
其中包括一组示例，用python 3编写。
您可以安装sdk，也可以运行如下示例：
PYTHONPATH=. python samples/samplename.py
建立文档
可以通过安装sphinx和sphinx_rtd_theme来构建文档。
简单的运行make在docs内，它将列出可用的输出格式。
欢迎加入QQ群-->： 979659372
