Skip to main content

A Python SDK for heychat (黑盒语音)

Project description

heychat.py

Python SDK for HeyChat

安装

pip install heychat

最简示例

from heychat import Bot, Message

bot = Bot('your_token')

@bot.command('hello')
async def hello(msg: Message):
    await msg.reply('world!')

bot.run()

更多功能

✅ 命令参数处理
from heychat import Bot, Message
from random import randint

bot = Bot('your_token')

@bot.command('roll')
async def hello(msg: Message,max_num):
    # 需先前往小黑盒开发平台为注册指令添加变量
    # 如果没有添加变量单纯输入 /roll 100 也可解析
    max_num = int(max_num)
    await msg.reply(f"你掷出了{randint(1,max_num)}")

bot.run()
✅ 获取基础信息
from heychat import Bot, Message

bot = Bot('your_token')

@bot.on_message()
async def on_message(msg: Message):
    # 用户
    print(msg.author.username) # 用户名
    print(msg.author.nickname) # 房间昵称
    print(msg.author.id)       # 用户ID

    # 消息
    print(msg.content)         # 消息内容
    print(msg.msg_timestamp)   # 消息时间戳
    
    # 房间
    print(msg.ctx.guild.id)    # 房间ID
    print(msg.ctx.guild.name)  # 房间名
    
    # 频道
    print(msg.ctx.channel.id)  # 频道ID
    print(msg.ctx.channel.name)# 频道名
    

bot.run()
✅ MD构建
import MDMessage
@bot.on_message()
async def on_message(msg: Message):

    img_path = "./img.png"
    await upload_img(img_path)

    md_msg = MDMessage()
    md_msg.apeend("这是一段文字")
    md_msg.append(Element.TEXT("这也是一段文字"))
    md_msg.append(Element.MENTION("18661718")) # @
    md_msg.append(Element.IMG("https://chat.max-c.com/attachments/2024-09-15/1835322670233686016_UitVbhhcLf.jpg"))

    # or
    
    md_msg = MDMessage("这是一段文字",
                        Element.TEXT("这也是一段文字"),
                        Element.IMG("https://chat.max-c.com/attachments/2024-09-15/1835322670233686016_UitVbhhcLf.jpg"),
                        Element.MENTION("18661718"))
    

    await msg.reply(md_msg)
✅ 支持更多指令变量类型
已经看了,觉得不需要适配现在的够用了,如果有具体需求欢迎提出
✅ 从type5转移至type50
(划掉)等什么时候官方把type5删了再写(划掉)已经写了
❌ 事件处理
@bot.on_event(EventType.JOIN_GUILD)
async def on_join_guild(event: JoinGuildEvent):
    pass

贡献

欢迎大家提供建议以及pr!

写在最后的省流

抄的khl.py
用的ChatGPT
对了家人们有没有会pypi的教教我怎么发包() 太蠢了整不明白

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

heychat-0.0.2.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

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

heychat-0.0.2-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file heychat-0.0.2.tar.gz.

File metadata

  • Download URL: heychat-0.0.2.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.11

File hashes

Hashes for heychat-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f598d6158e491d4b6ad5d2c27719cd7c56887980dcf274cf91c7cf4041efc236
MD5 21cc856b98ac7871afd6dcf0e43839c6
BLAKE2b-256 aac1c87af0fdc09488c3367a9f240e493b313b6f3585074201fa9c4fecb73aad

See more details on using hashes here.

File details

Details for the file heychat-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: heychat-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.11

File hashes

Hashes for heychat-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d6e5a95ffd3abf35d5d6cade4b34b4d4a566cc79df8e367865e6d034f4a7a0f4
MD5 21b5fbb7b3df35a7002ae2061de1c4df
BLAKE2b-256 0df6c2e97b9c2e8028d90c73ca7ba5c341f788145ea0bc2d3aef440964476908

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