MR 机器人 - Python

简介

MR 机器人是一个基于 Python 编写的开源聊天机器人。它能够通过配置文件进行个性化设置和扩展，并可接入多种聊天平台。

特性

• 支持多种聊天平台，如 Telegram、Discord、Slack 等。
• 可根据个性化配置实现自定义功能。
• 支持多种消息类型，如文本、图片、视频、音频等。
• 提供多种插件，如翻译、天气、闲聊等。
• 提供易于使用的 API 接口。

安装

可以通过 pip 安装 MR 机器人：

pip install mrbot

或者从源代码安装：

git clone https://github.com/mrbot-ai/mrbot.git
cd mrbot
pip install .

快速入门

创建机器人实例

要创建一个 MR 机器人实例，只需传入一个配置文件：

from mrbot import MRBot

bot = MRBot(config_file='config.yml')

处理消息

接下来要处理消息。要实现这一点，只需为消息类型编写处理程序。例如，要为文本消息编写处理程序：

from mrbot.types import Message

@bot.on_message()
def handle_text(message: Message):
    # do something
    pass

发送消息

要发送消息，只需调用 send_message 方法并传递要发送的消息类型：

from mrbot.types import TextMessage

bot.send_message(TextMessage(chat_id='123', text='Hello, World!'))

运行机器人

现在，你只需要调用 start 方法来运行机器人：

bot.start()

配置文件

配置文件是 MR 机器人的核心，它允许你个性化设置和扩展机器人。以下是一个简单的配置文件示例：

telegram:
  api_key: your-telegram-api-key
slack:
  api_key: your-slack-api-key
discord:
  api_key: your-discord-api-key

plugins:
  - name: translate
    config:
      from_lang: en
      to_lang: zh-CN
  - name: weather
    config:
      api_key: your-weather-api-key
      city: Beijing

default:
  - translate
  - weather

在此配置文件中，我们提供了 Telegram、Slack 和 Discord 的 API 密钥，并列出了要使用的插件及其配置选项。

插件

插件是可与机器人集成的小型应用程序。它们与核心机器人分离，并通过 API 与机器人交互。以下是 MR 机器人中可用的插件：

• 翻译插件：使用 Google Translate API 进行翻译。
• 天气插件：提供实时天气预报。
• 闲聊插件：提供与用户的闲聊交互。

API

MR 机器人提供了易于使用的 API 接口，可以让开发者轻松地与机器人交互。以下是可用的 API 方法：

• bot.send_message：用于向聊天中发送消息。
• bot.get_updates：用于检索未读取消息。