aiotraq-bot 0.2.5

Async ready traQ Bot library

AiotraQ-Bot

Async ready traQ Bot library written in Python.

Requirements

AiotraQ-Bot は以下のライブラリを使用しています。

• FastAPI: サーバーの実装
• Uvicorn: サーバーの実行
• Pydantic: データのバリデーション

Installation

pip install aiotraq-bot

Usage

TraqHttpBot を使って http bot を作成することができます。

traQ->BOTサーバーへのイベント受け取り部分を補助します。 BOTサーバー->traQへのイベント送信は AiotraQ、AiotraQ-Message 等を利用してください。

import os
from aiotraq_bot import TraqHttpBot

bot = TraqHttpBot(verification_token=os.getenv("BOT_VERIFICATION_TOKEN"))

@bot.event()
async def on_message(payload: MessageCreatedPayload):
    print(payload)

if __name__ == "__main__":
  bot.run()

Event handler の登録

イベントの登録は @bot.event() デコレータを使って行うことができます。 event の引数として対象のイベントを指定するか、関数の型ヒントを使って指定することができます。

MESSAGE_CREATED イベントを型ヒントを使って指定する場合

@bot.event()
async def on_message(payload: MessageCreatedPayload):
    print(payload)

MESSAGE_CREATEDイベントを引数を用いて指定する場合

@bot.event("MESSAGE_CREATED")
async def on_message(payload):
    print(payload)

詳細は ドキュメント|Bot サーバーの作成を参照してください。

Acknowledgements

This project is inspired by python-traq-bot.

License

This project is licensed under the terms of the MIT license.