errbot

errbot

errbotはチャットボットです。何らかの理由でチャットルームからインタラクティブにスクリプトを開始することができます：ランダムなユーモア、チャットオップス、ビルドの開始、監視、アラートのトリガー...

書かれており、Pythonで簡単に拡張できます。

Errbotはオープンソースソフトウェアとして利用でき、GPL V3ライセンスの下でリリースされます。

特徴

チャットサーバーのサポート

組み込み

• IRCサポート
• 電報サポート
• XMPPサポート

アドオン付き

• スラックサポート（指示を参照）
• 不一致（指示を参照）
• ギターサポート（指示を参照）
• WebEx（手順を参照）
• ほとんどの場合（指示を参照）
• Rocketchat（指示を参照）
• Skype（指示を参照）
• Tox（指示を参照）
• VK（指示を参照）
• Zulip（指示を参照）

管理

最初のインストールとセキュリティのセットアップの後、BOT（Chatops）とチャットするだけでERRBOTを管理できます。

• Gitでホストされているプラ​​イベートプラグインまたはパブリックプラグインをインストール/アンインストール/更新/無効化/無効化します
• プラグインはチャットから構成できます
• ボットを指示して、マルチユーザーチャットルーム（MUC）に参加/出発
• セキュリティ：ACLコントロール機能（コマンドごとの管理者/ユーザー権）
• バックアップ：統合コマンド！バックアップは、永続的なデータの完全なエクスポートを作成します。
• ログ：チャットから検査したり、Sentryにストリーミングしたりできます。

開発者機能

• Pythonで非常に簡単に拡張できます！ （以下を参照してください）
• すべてのプラグインのプリセットアップストレージ、つまりself['foo'] = 'bar'値を持続させます。
• 会話は、ユーザーから会話状態を追跡するために流れます。
• WebHookコールバックサポート
• テーブル、埋め込み画像、リンクなどでマークダウンエクストラのフォーマットをサポートします。
• チャットによってプラグインを構成できるように構成ヘルパー
• テキスト開発/デバッグコンソール
• 自己文書化：あなたのドキュストリングは自動的に助けになります
• サブコマンドとさまざまなArgの解析オプションが利用可能です（RE、コマンドラインタイプ）
• ポーリングサポート：あなたは定期的に何かをするようにプラグインをセットアップすることができます
• エンドツーエンドテストバックエンド
• Slackの下でのカードレンダリング

コミュニティとサポート

あなたが持っている場合：

• 簡単な質問GitterのErrbotio/Errbotでチャットに参加してください。
• プラグインの開発の質問タグERRBOTとPythonを使用してStackOverFlowを使用してください。
• 報告するバグまたは機能リクエストは、GitHubプロジェクトページを使用してください。

ハッシュタグ#errbotでTwitterで私たちをpingすることもできます。

インストール

前提条件

ERRBOTは、Linux、Windows、MacでPython 3.6+で実行されます。一部のチャットシステムには、ボットにアクセスするためにキーまたはログインが必要です。

クイックスタート

virtualenvをセットアップすることをお勧めします。

1. PIPからERRBOTをインストールします
2. Errbotのデータファイルをホストするために（ここでerrbotと呼ばれる）どこかにディレクトリを作成します
3. ディレクトリを初期化します
4. テキストモードでerrbotを試してください

$ pip install errbot
$ mkdir errbot ; cd errbot
$ errbot --init
$ errbot

それはあなたにプロンプ​​トを表示します>>>あなたはあなたのボットと直接話すことができます！試してみてください！手伝いを始めてください。

チャットシステムのサポートを追加します

ビルトインの場合、これらのオプションテレグラム、IRC、XMPPをPIPで使用するだけで、最初のインストール後も行うことで、たとえば不足しているサポートを追加できます。

 $ pipインストール「errbot [IRC]」

外部のもの（Slack、Discord、Gitter、Skypeなど）については、指示についてはそれぞれのgithubページに従ってください。

構成

これらのチャットシステムのいずれかに接続するようにERRBOTを構成するには、errbot（Init）によって生成されたconfig.pyファイルを調整する必要があります。

あなたを助けるために、ここで文書化されたテンプレートをここから入手できます：config-template.py。

注：構成からバックエンドを変更した場合でも、ERRBOT -Tを使用してテキストモードでインスタンスをローカルにテストできます。

デーモンとして誤差を開始します

すべてが機能した場合、-D（または-daemon）パラメーターを使用して、デタッチされたモードで実行できます。

errbot --daemon

ボットとの対話

ERRBOTを起動した後、まだバディリストにボットを追加していない場合は、ボットを追加する必要があります。いくつかのチャットシステムのチャットルームに明示的にボットを招待する必要があります。これでコマンドをボットに直接送信できます！

利用可能なすべてのコマンドのリストを取得するには、次のことを発行できます。

 ! help

特定のコマンドについてもっと知りたい場合は、次のことを発行できます。

 ! help command 

プラグインの管理

ハンドルがconfig.pyのbot_adminsリストにある場合、1対1のチャットでボットを管理できます。

たとえば、パブリックプラグインのリポジトリでキーワード検索を発行できます。

 ! repos search jira

このリストからプラグインをインストールするには、問題を課します。

 ! repos install < name of repo >

たとえば、reposはerrbotio/err-imagebotをインストールします。

プラグインを書く

独自のプラグインを書くのは非常に簡単です。 errbot - Initは、プラグインサブディレクトリに、ベースとして使用できるErr-Exampleというプラグインをインストールします。

例として、これは「こんにちは、世界！」を作成するのに必要なすべてです。 errbotのプラグイン：

 from errbot import BotPlugin , botcmd

class Hello ( BotPlugin ):
    """Example 'Hello, world!' plugin for Errbot"""

    @ botcmd
    def hello ( self , msg , args ):
        """Return the phrase "Hello, world!" to you"""
        return "Hello, world!"

このプラグインは、発行されたときに「Hello、World！」を返すコマンド「！hello」を作成します。あなたへ。プラグインでできるすべての情報については、プラグイン開発ガイドを参照してください。

errbot自体への貢献

GitHubの変更をお気軽にフォークして提案してください