Skip to main content

NoneBot adapter for WeChat

Project description

NoneBot-Adapter-Gewechat

✨ NoneBot2 Gewechat Protocol适配器 / Gewechat Protocol Adapter for NoneBot2 ✨

license version python pypi download

简介

本项目为 NoneBot2 提供了一个 Gewechat 适配器。

安装

pip

pip install nonebot-adapter-gewechat
# 如果需要将登录二维码保存为图片,请使用以下命令安装
pip install nonebot-adapter-gewechat[png]

nb cli

nb adapter install nonebot-adapter-gewechat
# 如果需要将登录二维码保存为图片,请使用以下命令安装
nb adapter install nonebot-adapter-gewechat[png]

配置

Driver 配置

需要 HTTP 客户端驱动器ASGI 服务端驱动器
推荐 fastapi+httpx

DRIVER="~fastapi+~httpx"

Gewechat 配置

GEWECHAT_API_URL="http://127.0.0.1:2531/v2/api"
GEWECHAT_DOWNLOAD_API_URL="http://127.0.0.1:2532/download"
GEWECHAT_CALLBACK_URL="http://127.0.0.1:8080/gewechat/callback/collect"
GEWECHAT_CALLBACK_PATH="/callback/collect"
SELF_MSG=false

配置对应 Gewechat 的配置

  • GEWECHAT_API_URL Gewechat API 地址
  • GEWECHAT_DOWNLOAD_API_URL Gewechat 下载 API 地址
  • GEWECHAT_CALLBACK_URL 接收回调地址
  • GEWECHAT_CALLBACK_PATH Gewechat 回调路径
  • SELF_MSG 是否接收自己发送的消息

账号配置

WXID="wxid_xxxxx"
APPID="wx_xxxxxxx"

其中,APPID 留空即为更换设备登录,首次登录请留空

API接口

具体接口可前往GeweChat文档查看, Bot类中已封装接口

[!WARNING] Gewechat目前只支持图片的下载,语音、视频等暂不支持

示例

from nonebot import on_message
from nonebot.adapters.gewechat.message import MessageSegment, Message
from nonebot.adapters.gewechat.event import ImageMessageEvent, EmojiMessageEvent
from nonebot.adapters.gewechat.bot import Bot

revoke = on_message(priority=5)
@revoke.handle()
async def _(bot: Bot, event: ImageMessageEvent):
    await bot.revokeMsg(
        event.FromUserName,
        event.MsgId,
        event.newMsgId,
        event.CreateTime
    )

emoji = on_message(priority=10)
@emoji.handle()
async def _(bot: Bot, event: EmojiMessageEvent):
    await emoji.send(MessageSegment.emoji(
        event.md5,
        event.md5_size
    ))

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_gewechat-0.5.2.tar.gz (32.2 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_gewechat-0.5.2-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_adapter_gewechat-0.5.2.tar.gz.

File metadata

  • Download URL: nonebot_adapter_gewechat-0.5.2.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nonebot_adapter_gewechat-0.5.2.tar.gz
Algorithm Hash digest
SHA256 ad431fd2337645c990d124a6c73ac2e15b61e993d69fa5c8ce81397fc431b42b
MD5 4ff93d6825f7bf93c84a73b363fe9e08
BLAKE2b-256 b3e06c2ed4f2e15fcbb72b5d53ed9b639097e00d12b1fa34ccd85f6d28acfe3f

See more details on using hashes here.

Provenance

The following attestation bundles were made for nonebot_adapter_gewechat-0.5.2.tar.gz:

Publisher: pypi-publish.yml on Shine-Light/nonebot-adapter-gewechat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nonebot_adapter_gewechat-0.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_adapter_gewechat-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dab5cc594f936803ef59a57cb737df5abd34f4ebf7fbe6fb7c19cbd3654c0148
MD5 5b3aca90e1fc5fc5eb218e5746b54c2c
BLAKE2b-256 2718cd613ee3a711a47eeda87c4bbc77250e0f8575a13790232618c140847868

See more details on using hashes here.

Provenance

The following attestation bundles were made for nonebot_adapter_gewechat-0.5.2-py3-none-any.whl:

Publisher: pypi-publish.yml on Shine-Light/nonebot-adapter-gewechat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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