MiPA はDiscord.py ライクな書き方ができるように作っている MisskeyApi wrapper です
MiPAはMiPACというライブラリに依存しています。これはMiPAのCore部分をまとめた物であり、基本的にはApiへのアクセス用メソッドなどを提供します。MiPAではMiPACのメソッド群をそのまま公開している為、MiPAC側で大きな変更が入るとMiPAを使用しているプロジェクトでもその影響を受ける可能性があります。そのため、CHANGELOG.md で MiPACのバージョンが変更された際はそのリリースノートへのリンクを添付しています。予めMiPAC側での変更を確認したうえでアップデートをお願いします。
- このプロジェクトは開発中です。仕様が定まっていないため、破壊的変更が多いです。
masterブランチで使用しているmipacはGitHubにあるmipacのdevelopブランチの物です。
import asyncio
from aiohttp import ClientWebSocketResponse
from mipac import Note
from mipac.models import ChatMessage
from mipa.ext.commands.bot import Bot
class MyBot(Bot):
def __init__(self):
super().__init__()
async def _connect_channel(self):
await self.router.connect_channel(['main', 'home'])
async def on_ready(self, ws: ClientWebSocketResponse):
await self._connect_channel()
print('Logged in ', self.user.username)
async def on_reconnect(self, ws: ClientWebSocketResponse):
await self._connect_channel()
async def on_note(self, note: Note):
print(note.author.username, note.content)
async def on_chat(self, message: ChatMessage):
print(message.user.username, message.text)
if message.text == 'hello':
await self.client.chat.action.send(
f'hello! {message.user.username}',
user_id=message.user.id
)
if __name__ == '__main__':
bot = MyBot()
asyncio.run(bot.start('wss://example.com/streaming', 'your token here'))Want more examples? Go to the examples folder! Want to know how to use a feature that isn't even here? Submit a request in an Issue!
MiPAで作ったBotなどをGitHubなどで公開している場合は、Issueなどに送信してくだされば、MiPAで作られている物に追加します。また、良ければBotのプロフィールなどにこのBotはMiPAで作成されているとの旨を記載してくださると嬉しいです。
- akari
- 作者の yupix が作成しているBotです。クリーンアーキテクチャを用いているため、部分的に分かりにくい所があるかもしれません。
このプロジェクトでは blackのforkである、axblackを利用しています。主な違いはダブルクォートがデフォルトではなく、シングルクォートになっている点です
このプロジェクトは MIT LICENSE で提供されます。
MiPAでは多くの部分においてDiscord.pyを参考にさせていただきました。そのため、Discord.pyのソースコードを利用させていただいている個所ではファイルの初めにDiscord.py側のライセンスを明記しています。詳しくはコードを確認してください。
- Discord.py
- Cogの仕組みやtask,stateの管理等多くの部分で参考にさせていただきました。