botfriend 0.5.0

好友

botfriend是一个python框架，用于管理许多创造性的bot 发到许多不同的服务上。

我认为botfriend的主要特点是：

• 最简单的python编码——只需编写机器人的有趣部分即可。
• 基于yaml的简单配置。
• 轻松安排职位。
• 每个机器人都可以发布到Twitter和/或乳齿象。（计划支持Tumblr。）
• 内置访问艺术用品的途径olipy

botfriend是一个运行在服务器上的python库。如果你不是 我习惯于设置cron作业或编写python代码 建议您改为查看廉价机器人，完成 快速或廉价机器人 甜美！，作为一种更简单的表达方式 你的创造力。

故事

我写信给BotFriend是为了管理30个不同的Twitter 我创建的机器人程序。我发现自己 不断地复制和粘贴，编写相同的代码 结束。每个机器人都做不同的事情，但他们都有 基本需求：连接到各种服务和api，决定何时 发布一些内容，管理积压的内容，等等。没有 原因是每个机器人都需要自己版本的代码。唯一的部分 需要新代码的机器人才是最有创意的。

我的另一个大问题是，我开始讨厌推特了。真是太棒了 创造机器人的平台，但每次我创造一个机器人，我就感觉 我对提高平台价值感到内疚 世界更糟。（而且，Twitter已经开始无缘无故地暂停我的机器人程序。）

我不想放弃我做肉馅的爱好，所以我开始 调查乳齿象的世界 机器人。这就产生了另一个问题：重写30个 发送到其他服务的机器人程序。如果我要做那么多 我希望最终产品是一个可重用的库 节省所有人的时间。

所以我浏览了我的30个机器人，重写了所有内容，移动了所有 将可重用代码转换为botfriend。现在我的机器人小了很多 更容易管理。所有乏味的代码都在一个地方，我可以 专注于机器人写作的有趣部分。

考虑一个机器人，比如一个乏味的机器人 （源代码）。创建 这个机器人是相当多的工作。但所有的工作 有趣的部分：从 闪耀的。没有代码可以确保机器人在 小时，或通过twitter推送输入的文本，或 乳齿象API。两个朋友负责所有的事情。

如果要在自己的bot项目上保存代码，请从 我希望你可以在Twitter上给乳齿象留言，或者扩大你的机器人的覆盖范围 你可以考虑交个朋友。

设置

我建议您在python虚拟环境中运行botfriend。这里是 如何创建名为env的虚拟环境并安装botfriend 进入它。

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

您将通过命令行专门与botfriend交互 脚本。从现在起，我将给出许多示例命令 线。我所有的例子都假设你输入了虚拟的僵尸朋友 预先运行此命令的环境：

$ source env/bin/activate

一个简单的例子：数字笑话

默认情况下，botfriend希望您将bots的源代码 在与虚拟机位于同一目录的bots/目录中 环境。如果你的虚拟环境位于 /home/myusername/botfriend/env，botfriend会希望您的机器人 生活在下面>/home/myusername/botfriend/bots

botfriend数据库本身将作为 botfriend.sqlite

如果您想将botfriend数据存储在bots/之外的其他地方， 每个botfriend脚本都有一个指向 机器人程序目录。但大多数情况下，机器人程序/是可以的。

每个机器人都将生活在机器人目录的子目录中， 以机器人命名。让我们从一个简单的例子开始，称为 数笑话

$ mkdir bots
$ mkdir bots/number-jokes

每个bot都需要包含两个特殊文件：source的 编码并bot.yaml进行配置。

\uu init\uuu.py：搞笑

想象一下，走到一个喜剧演员跟前说"给我讲个笑话！"一 人类喜剧演员可能不会欣赏它，但这就是机器人 为生活而活。对于botfriend机器人来说，喜剧演员就在这里 提出他们的笑话。

首先，我们将制作一个简单的机器人 关于数字的幽默。

要开始，请在文本中打开 编辑并在其中写入：

import random
from botfriend.bot import TextGeneratorBot

class NumberJokes(TextGeneratorBot):

    def generate_text(self):
        """Tell a joke about numbers."""
        num = random.randint(1,10)
        arguments = dict(
            num=num,
            plus_1=num+1,
            plus_3=num+3
        )
        setup = "Why is %(num)d afraid of %(plus_1)d? "
        punchline = "Because %(plus_1)d ate %(plus_3)d!"
        return (setup + punchline) % arguments

Bot = NumberJokes

BotFriend提供了很多实用程序来帮助您编写 \uu init\uuuuu.py，但只有一条硬性规定：在 文件中，必须有一个名为bot的类。僵尸朋友脚本 将加载您的bot类，实例化它，并使用它 做…无论机器人做什么。

一些机器人做了很多工作来想出一个"笑话"。他们可能 画图，数据库查询，api调用，各种各样的 复杂的事情。作为一个例子，这里有 几乎没有工作。它只是选取一个随机数并将其放入字符串。

bot.yaml：讲笑话

和大多数喜剧演员一样，机器人也不断地编出笑话。但是如果 没人听过这个笑话，有什么意义？bot.yaml文件 解释botfriend机器人应该如何向公众讲述其笑话。

打开文件bots/number笑话/bot.yaml并在其中写入：

name: "Number Jokes"
schedule: 60
publish:
    file:
      filename: "number-jokes.txt"

像\uu init\uuuu.py，bot.yaml会变得非常复杂，但是 时间很简单。这个文件是说：

• 机器人的名字是"数字笑话"。

• 机器人应该每小时"讲一次笑话"。

• 这个机器人通过把笑话写进文件来讲笑话 数字笑话.txt。（这是相对于bot目录的，所以 加入机器人程序/number笑话/number笑话.txt）

现在你准备好让你的机器人讲一些笑话，用一些基本的 好友脚本。

基本脚本

botfriend.post

botfriend.post脚本使您的每个机器人 开玩笑说出来。立即运行：

$ botfriend.post
# Number Jokes | file | Published 2019-01-20 | Why is 4 afraid of 5… 

现在看看您在bot.yaml中配置的文件。你说的号码 将笑话发布到bots/number笑话/number笑话.txt。该文件 在运行botfriend.post之前不存在，但现在它确实存在， 里面有个笑话：

$ cat bots/number-jokes/number-jokes.txt
2019-01-20 10:23:44 | Why is 4 afraid of 5? Because 5 ate 7!

很搞笑，对吧？你会经常运行这个脚本，可能是 自动化过程的一部分。在我的网站上，我运行botfriend.postevery 五分钟。（在本文结尾，我展示了一个如何做到这一点的示例 文档。）

如果你的机器人没有被安排讲笑话，botfriend.post就可以了 没有什么。现在再运行一次--什么都不会发生。

$ botfriend.post

当你第一次运行一个笑话时，数字笑话告诉了它，并且（正如你所说的 在bot.yaml中，一小时只能讲一个笑话。所以，没有 新笑话。

如果你等一个小时再运行botfriend.post 又一个笑话。但是不要等——继续学习这个教程！

只在一个机器人上运行脚本

通过在命令行上指定目录名，可以 botfriend.post（和大多数其他botfriend脚本）仅在 一个机器人，不是你所有的机器人。现在，它不能 区别在于，因为您只有一个机器人，但以下是操作方法：

$ botfriend.post number-jokes

强制机器人发布

您可以使用--force让机器人讲笑话，即使它的时间表是 通常是不允许的。

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ virtualenv env
$ source env/bin/activate
$ pip install botfriend

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ source env/bin/activate

$ mkdir bots
$ mkdir bots/number-jokes

$ mkdir bots
$ mkdir bots/number-jokes

$ mkdir bots
$ mkdir bots/number-jokes

$ mkdir bots
$ mkdir bots/number-jokes

$ mkdir bots
$ mkdir bots/number-jokes

import random
from botfriend.bot import TextGeneratorBot

class NumberJokes(TextGeneratorBot):

    def generate_text(self):
        """Tell a joke about numbers."""
        num = random.randint(1,10)
        arguments = dict(
            num=num,
            plus_1=num+1,
            plus_3=num+3
        )
        setup = "Why is %(num)d afraid of %(plus_1)d? "
        punchline = "Because %(plus_1)d ate %(plus_3)d!"
        return (setup + punchline) % arguments

Bot = NumberJokes

import random
from botfriend.bot import TextGeneratorBot

class NumberJokes(TextGeneratorBot):

    def generate_text(self):
        """Tell a joke about numbers."""
        num = random.randint(1,10)
        arguments = dict(
            num=num,
            plus_1=num+1,
            plus_3=num+3
        )
        setup = "Why is %(num)d afraid of %(plus_1)d? "
        punchline = "Because %(plus_1)d ate %(plus_3)d!"
        return (setup + punchline) % arguments

Bot = NumberJokes