Errbot

Errbot

Errbot ist ein Chatbot. Sie können aus irgendeinem Grund Skripte aus Ihren Chatrooms aus starten: zufälliger Humor, Chatops, Starten eines Builds, Überwachungs Commits, Auslösen von Warnungen ...

Es ist in Python geschrieben und leicht erweiterbar.

Errbot ist als Open-Source-Software verfügbar und unter der GPL V3-Lizenz veröffentlicht.

Merkmale

Chat -Server Support

Eingebaut

• IRC -Unterstützung
• Telegrammunterstützung
• XMPP -Unterstützung

Mit Add-Ons

• Slack -Unterstützung (siehe Anweisungen)
• Zwietracht (siehe Anweisungen)
• Gitterunterstützung (siehe Anweisungen)
• WebEx (siehe Anweisungen)
• Materie (siehe Anweisungen)
• Rocketchat (siehe Anweisungen)
• Skype (siehe Anweisungen)
• Tox (siehe Anweisungen)
• VK (siehe Anweisungen)
• Zulip (siehe Anweisungen)

Verwaltung

Nach der ersten Installations- und Sicherheitsanlage kann ERRBOT verwaltet werden, indem Sie einfach mit dem Bot (CHATOPS) chatten.

• Installieren/Deinstallieren/Update/Aktivieren/Aktivieren/Deaktivieren Sie private oder öffentliche Plugins, die auf Git gehostet werden
• Plugins können aus dem Chat konfiguriert werden
• Legen Sie den Bot an, Multi -Benutzer -Chatrooms (MUC) zu beitreten/zu verlassen.
• Sicherheit: ACL -Steuerungsfunktion (Admin-/Benutzerrechte pro Befehl)
• Backup: Ein integrierter Befehl! Backup erstellt einen vollständigen Export von anhaltenden Daten.
• Protokolle: Kann vom Chat oder in Sachen überprüft werden.

Entwicklerfunktionen

• In Python sehr leicht zu verlängern! (siehe unten)
• Voreinsetzungsspeicher für jedes Plugin, dh self['foo'] = 'bar' behält den Wert an.
• Gesprächsströme, um Gespräche von Benutzern zu verfolgen.
• Webhook -Rückrufunterstützung
• Unterstützt die Formatierung von Markdown -Extras mit Tabellen, eingebettete Bilder, Links usw.
• Konfigurationshelfer, damit Ihr Plugin mit dem Chat konfiguriert werden kann
• Textentwicklung/Debugg -Konsolen
• Selbstdokumentation: Ihre Dokstrings werden automatisch helfen
• Unterbefehle und verschiedene Arg -Parsing -Optionen sind verfügbar (Betreff, Befehlszeilenart)
• Polling -Unterstützung: Sie können ein Plugin einrichten, um regelmäßig etwas zu tun
• End -to -End -Test -Backend
• Kartenwiedergabe unter Slack

Gemeinschaft und Unterstützung

Wenn Sie haben:

• Eine kurze Frage zögern Sie nicht, sich uns bei ERRBOTIO/ERRBOT auf dem Gitter zu Chat anzuschließen.
• Eine Plugin -Entwicklungsfrage Bitte verwenden Sie Stackoverflow mit den Tags Errbot und Python.
• Wenn Sie einen Fehler mit dem Bericht oder einer Feature -Anfrage erhalten, verwenden Sie bitte unsere GitHub -Projektseite.

Sie können uns auch mit dem Hashtag #errbot auf Twitter pingen.

Installation

Voraussetzungen

Errbot läuft unter Python 3.6+ unter Linux, Windows und Mac. Für einige Chat -Systeme benötigen Sie einen Schlüssel oder eine Anmeldung für Ihren Bot, um darauf zuzugreifen.

QuickStart

Wir empfehlen, einen Virtualenv einzurichten.

1. Installieren Sie Errbot von PIP
2. Machen Sie irgendwo ein Verzeichnis (hier genannt Erbot) in den Datendateien von Erbots Host
3. Initialisieren Sie das Verzeichnis
4. Probieren Sie Errbot im Textmodus aus

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

Es zeigt Ihnen eine Eingabeaufforderung >>>, damit Sie direkt mit Ihrem Bot sprechen können! Versuchen Sie! Helfen Sie, um loszulegen.

Hinzufügen von Unterstützung für ein Chat -System

Verwenden Sie für die Einbauten einfach eines dieser Optionen Telegram, IRC, XMPP mit PIP.

 $ pip Installation "Errbot [IRC]"

Für die externen (Slack, Zwietracht, Gitter, Skype usw.) folgen Sie bitte ihren jeweiligen Github -Seiten für Anweisungen.

Konfiguration

Um Errbot zu konfigurieren, um eine Verbindung zu einem dieser Chat -Systeme herzustellen, müssen Sie die von Errbot - -Init generierte Konfigurationsdatei optimieren.

Um Ihnen zu helfen, haben wir hier eine dokumentierte Vorlage verfügbar: config-template.py.

Hinweis: Selbst wenn Sie das Backend aus der Konfiguration geändert haben, können Sie ERRBOT -T verwenden, um Ihre Instanz lokal im Textmodus zu testen.

Errbot als Daemon starten

Wenn all das funktioniert hat, können Sie jetzt den Parameter -d (oder -daemon) verwenden, um ihn in einem abgelösten Modus auszuführen:

errbot --daemon

Mit dem Bot interagieren

Nach dem Start von Errbot sollten Sie den Bot zu Ihrer Kumpel -Liste hinzufügen, wenn Sie es noch nicht getan haben. Sie müssen den Bot auch in einigen Chat -Systemen explizit zu Chatrooms einladen. Sie können jetzt Befehle direkt an den Bot senden!

Um eine Liste aller verfügbaren Befehle zu erhalten, können Sie ausgeben:

 ! help

Wenn Sie nur mehr über einen bestimmten Befehl wissen möchten, können Sie ausgeben:

 ! help command 

Plugins verwalten

Sie können den Bot in einem Einzelgespräch verwalten, wenn sich Ihr Handle in der Liste Bot_admins in config.py befindet.

Zum Beispiel können Sie zur Keyword -Suche in den öffentlichen Plugin -Repos ausgeben:

 ! repos search jira

So installieren Sie ein Plugin aus dieser Liste: Problem:

 ! repos install < name of repo >

Zum Beispiel! Repos installieren Sie Errbotio/Err-ImageBot.

Plugins schreiben

Das Schreiben Ihrer eigenen Plugins ist extrem einfach. ERRBOT-Init hat im Plugins-Subverzeichnis ein Plugin mit dem Namen Err-Example installiert, das Sie als Basis verwenden können.

Als Beispiel ist dies alles, was es braucht, um eine "Hallo, Welt!" Plugin für 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!"

Dieses Plugin erstellt den Befehl "! Hallo", der, wenn er ausgestellt wird, "Hallo, Welt!" zu dir. Weitere Informationen zu allem, was Sie mit Plugins machen können, finden Sie im Plugin -Entwicklungshandbuch.

Beitrag zu Erbot selbst

Fühlen Sie sich frei, sich zu gabelieren und Änderungen am GitHub vorzuschlagen