YHChatPythonSDK

UnOfficialSDK

此 SDK 适用于 Python3.7 及以上版本。
使用此 SDK 可以构建您的云湖机器人，能让您以非常便捷的方式和云湖服务进行交互。

目前实现的功能:消息发送，所有类型订阅接收，端口开放测试

依赖:

Bottle:
pip install bottle
requests:
pip install requests

使用方法：

在一切开始之前，请确保你的订阅链接设置为ip:port/sub
要令一个函数进行消息接收，请引用本SDK并使用@onMessage装饰器
要接收指令消息，请使用@onCommand(cmd='commandName')装饰器
要接收关注消息，请使用@onFollowed装饰器
要接收取关消息，请使用@onUnfollowed装饰器
要接收入群消息，请使用@onJoin装饰器
要接收退群消息，请使用@onLeave装饰器
要只接受普通文本消息（包含text与markdown类型）请使用@onTextMessage装饰器
例子:

from YHlib import onMessage,runBot
@onMessage
def onRecvMsg(ctx):
    print(ctx)
runBot(token="xxx",port=7888)

要发送消息，请使用`sendMsg()`函数

sendMsg参数:

recvId :String 接收者id,输入列表视为群发
recvType :String 取值:"group";"user",接收者类型
contentType :String 取值:"text";"image";"markdown";"file",消息类型
content :String 消息正文，注意：这只在text和markdown类型下有效
fileName :String 文件名，注意：这只在file类型下有效
url :String 资源链接，注意：这只在file,image类型下有效
buttons :List 按钮，具体内容请参阅官方文档,默认不使用

附注:按钮只需单层列表

例子:

from YHlib import setToken,sendMsg
setToken(token="xxx")
sendMsg("653505810","group","text","HelloWorld")

其他功能:

端口开放测试:

from YHlib import runBot,ping
runBot(token="xxx",port=7888)

之后使用浏览器访问
外网IP:7888/ping
成功看到pong即为端口开放成功

小礼物:`Identify.py`:

针对目前没有官方的用户ID转用户名的api，制作了这个基于关注和入群事件的转换脚本
使用方法如下:

import Identify
#Yid在此处代表用户id
print(Identify.fetch(Yid))

ninewan/YHChatPythonSDK