Skip to main content

A NoneBot adapter for YunHu

Project description

nonebot

NoneBot-Adapter-YunHu

✨ YunHu adapter for NoneBot2 ✨

PyPI GitHub

支持情况

事件支持情况

  • 基础消息事件
  • 按钮事件上报接收
  • 机器人设置事件
  • 按钮发送
  • 表单发送

支持的消息元素

元素 支持情况
文本 Text
图片 Image
提及用户 At(user)
按钮 Buttons
表单 Form
表情包 expression ⬇️
语音 Audio ⬇️
视频 Video
文件 File
HTML HTML
文章 Post
Markdown
提示信息 Tip ⬇️
回复 Reply

支持的消息操作

操作 支持情况
发送 Send
撤回 Recall
编辑 Edit
表情响应 Reaction 🚫

简介

nonebot-adapter-yunhu 是为 NoneBot2 设计的云湖(YunHu)平台适配器,支持开发云湖机器人,提供完整的消息和服务支持。

安装

使用 pip 安装

pip install nonebot-adapter-yunhu

使用 nb-cli 安装

nb adapter install nonebot-adapter-yunhu

使用 poetry 安装

poetry add nonebot-adapter-yunhu

配置

在您的 NoneBot 项目配置文件 .env 中添加以下配置:

app_id 是 Bot 的 ID,可在 bot 信息页面查看

DRIVER=~fastapi+~httpx

YUNHU_BOTS = '[{
    "app_id": "123456",
    "token": "xxx",
}
]
'

HOST = 0.0.0.0
PORT = 8080

bot.py 中注册适配器:

import nonebot
from nonebot.adapters.yunhu import Adapter as YunhuAdapter

nonebot.init()

driver = nonebot.get_driver()
driver.register_adapter(YunhuAdapter)

在云湖控制台,上报地址为 http(s)://{HOST}:{PORT}/yunhu/{app_id}

使用方法

基本用法

from nonebot import on_command
from nonebot.adapters.yunhu import Bot, Event

echo = on_command("echo")

@echo.handle()
async def handle_echo(bot: Bot, event: Event):
    await echo.finish(event.get_message())

发送不同类型的消息

具体类型参考 message.py

from nonebot import on_command
from nonebot.adapters.yunhu import Bot, Event, MessageSegment

send_image = on_command("image")

@send_image.handle()
async def handle_send_image(bot: Bot, event: Event):
    # 发送文本
    await bot.send(event, MessageSegment.text("Hello World"))
    # 有一种更简单的写法可以不用在上方写bot传参
    # await send_image.send(MessageSegment.text("test"))

    # 发送图片(需要先上传图片获取 image_key)/ 也可以直接传参raw=bytes,适配器会自动上传
    await bot.send(event, MessageSegment.image("image_key"))

    # @某人
    await bot.send(event, MessageSegment.at("user_id"))

获取帮助

image
  • 加入云湖群聊【NoneBot 云湖适配器交流群】: 链接
  • 群 ID: 519215204

相关链接

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_adapter_yunhu-0.1.0.tar.gz (22.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonebot_adapter_yunhu-0.1.0-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_adapter_yunhu-0.1.0.tar.gz.

File metadata

  • Download URL: nonebot_adapter_yunhu-0.1.0.tar.gz
  • Upload date:
  • Size: 22.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.14.2 Linux/6.11.0-1018-azure

File hashes

Hashes for nonebot_adapter_yunhu-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e34d9bbf6cc6f6ae14b1aa70a4be8c643c54f48307725c4624cb3d1db5d6b394
MD5 4bcb5def01331778e399e31ffe604ed6
BLAKE2b-256 e0427a50354ae47c4ff33f5f0ec1d78b9a339608b283011d2a0ba2fffe2cb225

See more details on using hashes here.

File details

Details for the file nonebot_adapter_yunhu-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_adapter_yunhu-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d7ce6e132f31eacb68b208681ce4e5d8cceac4104393859934497c29f12e4cf
MD5 c2bccc82a88afd6c43928b453141931f
BLAKE2b-256 90a69a51d73e5fafa42ca4cd8f8173f31a748537049cd095f315f8ed219c0711

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page