跳转到主要内容

SimpleBot: 可扩展的Delta Chat机器人

项目描述

⚠️ 重要: 此项目不再受到高度重视,您应该使用: https://github.com/deltachat-bot/deltabot-cli-py

SimpleBot

Latest Release Supported Versions Downloads License CI Code style: black Contributors

一个可扩展的Delta Chat机器人。

安装

要安装SimpleBot的最新稳定版本,请运行以下命令(最好在虚拟环境中)

pip install simplebot

测试未发布版本

pip install git+https://github.com/simplebot-org/simplebot

⚠️ 注意: 如果Delta Chat Python绑定包不可用于您的平台,您需要手动编译和安装绑定,更多信息请参阅Delta Chat文档

使用Docker构建

# building image
docker build -t simplebot .
# running container with simplebot
# "/home/bot_volume" absolute path for storing bot data on host system
docker run -it -v /home/bot_volume:/root/.simplebot simplebot bash

在容器bash中,您可以运行与快速入门部分中相同的应用程序。

快速入门:运行机器人+插件

(将变量 $ADDR$PASSWORD 替换为机器人将使用的电子邮件和密码)

  1. 向机器人添加账户

    simplebot init "$ADDR" "$PASSWORD"
    
  2. 安装一些插件

    pip install simplebot-echo
    
  3. 启动机器人

    simplebot serve
    

插件

SimpleBot是一个基础机器人,它依赖于插件来增加功能。

每个人都可以发布他们自己的插件,在PyPI中搜索以发现有趣的SimpleBot插件

⚠️ 注意: 以Python包(例如使用 pip)安装的插件对你在机器人中注册的所有账户都是全局的,要为每个账户分别插件,需要为每个账户运行其自己的虚拟环境。

为每个账户创建插件

如果你知道如何用Python编程,你可以快速创建插件并将它们安装到你的机器人中。

让我们创建一个“回声机器人”,创建一个名为 echo.py 的文件,并写入以下内容

import simplebot

@simplebot.filter
def echo(message, replies):
    """Echoes back received message."""
    replies.add(text=message.text)

就这样!你已经创建了一个插件,它将simplebot转换为一个“回声机器人”,它会回显你发送给它的任何文本消息。现在告诉simplebot注册你的插件

simplebot plugin --add ./echo.py

现在你可以启动机器人并从Delta Chat应用程序中向它写入,以看到你的新机器人正在运行。

查看 examples 文件夹,了解有关如何创建插件的示例。

用户注意事项

SimpleBot使用Autocrypt端到端加密,但请注意,机器人服务的运营商可以查看发送给它的消息。

致谢

SimpleBot标志由古巴设计师"Dann"设计。

项目详情


下载文件

下载适合您平台的文件。如果您不确定要选择哪个,请了解更多关于 安装包 的信息。

源分布

simplebot-4.1.2.tar.gz (182.1 kB 查看哈希值)

上传时间

构建分布

simplebot-4.1.2-py3-none-any.whl (142.0 kB 查看哈希值)

上传时间 Python 3

支持者: