python-mirai-core 0.6.5

A framework for OICQ(QQ, made by Tencent) headless client "Mirai".

Mirai Framework Core for Python

Derived from Python-Mirai. If you decided to Star this project, please also Star the original project.

A Flask like Python wrapper of Mirai-HTTP-API

See full documentation here

Installation

Install from PyPI

pip install python-mirai-core

Install from github

pip install git+git:://github.com/NatriumLab/python-mirai-core

TL; DR

See code completion generated by PyCharm or VSCode.

Fundamentals:

Bot and Updater are two object to interact with mirai-http-api.

Bot contains all outbound actions (such as send_group_message), all methods are well documented, and internal methods starts with _

Updater handles all inbound updates (such as receiving events or messages)

A list of available event is under mirai_core.models.events.EventTypes, and each event entity is under mirai_core.models.events, and shares the same name as EventTypes.

A list of available message components (to construct MessageChain) is under mirai_core.models.message.components.

Features

• Updater handshake with mirai-console automatically when console is restarted or session is expired

• Similar logic to python-telegram-bot or aiogram

• Supports multiple listener for single event, use return True to block further calling for this event only

• Supports Websocket (enabled by default)

• Supports xml/json/app message

Example

Basic example: see demo folder.

Comprehensive example: see UMR

Thanks

Thanks mamoe brings us mirai, a tremendous work that enables boundless possibilities for QQ Bots.

License

GNU AGPLv3

Same as mirai