errbot

Fehler

Errbot ist ein Chatbot. Es ermöglicht Ihnen, aus beliebigen Gründen interaktiv Skripte aus Ihren Chatrooms zu starten: zufälliger Humor, Chatops, Starten eines Builds, Überwachen von Commits, Auslösen von Warnungen ...

Es ist in Python geschrieben und leicht erweiterbar.

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

Merkmale

Unterstützung für Chat-Server

Eingebaut

• IRC-Unterstützung
• Telegram-Unterstützung
• XMPP-Unterstützung

Mit Add-Ons

• Slack-Unterstützung (siehe Anweisungen)
• Discord (siehe Anleitung)
• Gitterstütze (siehe Anleitung)
• Webex (siehe Anleitung)
• Mattermost (siehe Anleitung)
• RocketChat (siehe Anleitung)
• Skype (siehe Anleitung)
• TOX (siehe Anleitung)
• VK (siehe Anleitung)
• Zulip (siehe Anleitung)

Verwaltung

Nach der Erstinstallation und Sicherheitseinrichtung kann Errbot durch einfaches Chatten mit dem Bot (Chatops) verwaltet werden.

• Auf Git gehostete private oder öffentliche Plugins installieren/deinstallieren/aktualisieren/aktivieren/deaktivieren
• Plugins können über den Chat konfiguriert werden
• Weisen Sie den Bot an, Multi-User-Chatrooms (MUC) beizutreten/zu verlassen.
• Sicherheit: ACL-Kontrollfunktion (Administrator-/Benutzerrechte pro Befehl)
• Backup: Ein integrierter Befehl !backup erstellt einen vollständigen Export persistenter Daten.
• Protokolle: können im Chat eingesehen oder an Sentry gestreamt werden.

Entwicklerfunktionen

• Sehr einfach in Python zu erweitern! (siehe unten)
• Voreingestellter Speicher für jedes Plugin, dh self['foo'] = 'bar' behält den Wert bei.
• Konversationsflüsse, um den Konversationsstatus von Benutzern zu verfolgen.
• Unterstützung für Webhook-Rückrufe
• Unterstützt Markdown-Extras-Formatierung mit Tabellen, eingebetteten Bildern, Links usw.
• Konfigurationshilfe, damit Ihr Plugin per Chat konfiguriert werden kann
• Textentwicklungs-/Debug-Konsolen
• Selbstdokumentierend: Ihre Dokumentzeichenfolgen werden automatisch zur Hilfe
• Unterbefehle und verschiedene Argument-Parsing-Optionen sind verfügbar (bezüglich Befehlszeilentyp)
• Abfrageunterstützung: Sie können ein Plugin einrichten, um regelmäßig etwas zu tun
• End-to-End-Test-Backend
• Karten-Rendering unter Slack

Gemeinschaft und Unterstützung

Wenn Sie:

• Wenn Sie eine kurze Frage haben, besuchen Sie uns gerne im Chat unter errbotio/errbot auf Gitter.
• Wenn Sie eine Frage zur Plugin-Entwicklung haben, verwenden Sie bitte Stackoverflow mit den Tags errbot und python.
• Wenn Sie einen Fehler melden oder eine Funktionsanfrage stellen möchten, nutzen Sie bitte unsere GitHub-Projektseite.

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

Installation

Voraussetzungen

Errbot läuft unter Python 3.6+ auf Linux, Windows und Mac. Für einige Chat-Systeme benötigen Sie einen Schlüssel oder ein Login, damit Ihr Bot darauf zugreifen kann.

Schnellstart

Wir empfehlen die Einrichtung einer virtuellen Umgebung.

1. Installiere errbot von pip
2. Erstellen Sie irgendwo ein Verzeichnis (hier „errbot“ genannt), um die Datendateien von Errbot zu hosten
3. Initialisieren Sie das Verzeichnis
4. Probieren Sie Errbot im Textmodus aus

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

Es wird Ihnen eine Eingabeaufforderung >>> angezeigt, sodass Sie direkt mit Ihrem Bot sprechen können! Probieren Sie !help aus, um loszulegen.

Unterstützung für ein Chat-System hinzufügen

Für die integrierten Funktionen verwenden Sie einfach eine dieser Optionen: Telegram, IRC, XMPP mit Pip. Sie können dies auch nach der Erstinstallation tun, um beispielsweise die fehlende Unterstützung hinzuzufügen

 $ pip install „errbot[irc]“

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

Konfiguration

Um Errbot für die Verbindung mit einem dieser Chat-Systeme zu konfigurieren, müssen Sie die von errbot --init generierte Datei config.py anpassen.

Um Ihnen zu helfen, stellen wir hier eine dokumentierte Vorlage zur Verfügung: config-template.py.

Hinweis: Auch wenn Sie das BACKEND in der Konfiguration geändert haben, können Sie errbot -T weiterhin verwenden, um Ihre Instanz lokal im Textmodus zu testen.

Errbot als Daemon starten

Wenn alles funktioniert hat, können Sie es jetzt mit dem Parameter -d (oder --daemon) im getrennten Modus ausführen:

errbot --daemon

Interaktion mit dem Bot

Nachdem Sie Errbot gestartet haben, sollten Sie den Bot zu Ihrer Buddy-Liste hinzufügen, falls Sie dies noch nicht getan haben. Bei einigen Chat-Systemen müssen Sie den Bot auch explizit in Chatrooms einladen. Sie können jetzt Befehle direkt an den Bot senden!

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

 ! help

Wenn Sie einfach mehr über einen bestimmten Befehl erfahren möchten, können Sie Folgendes eingeben:

 ! help command 

Plugins verwalten

Sie können den Bot in einem Einzelchat verwalten, wenn Ihr Handle in der BOT_ADMINS-Liste in config.py enthalten ist.

Für die Stichwortsuche in den öffentlichen Plugin-Repos können Sie beispielsweise Folgendes eingeben:

 ! repos search jira

Um ein Plugin aus dieser Liste zu installieren, geben Sie Folgendes ein:

 ! repos install < name of repo >

Zum Beispiel !repos install errbotio/err-imagebot.

Plugins schreiben

Das Schreiben eigener Plugins ist äußerst einfach. errbot --init hat im Plugins-Unterverzeichnis ein Plugin namens err-example installiert, das Sie als Basis verwenden können.

Das ist beispielsweise alles, was man braucht, um ein „Hallo, Welt!“ zu erstellen. 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 „!hello“, der bei seiner Ausgabe „Hello, world!“ zurückgibt. zu dir. Weitere Informationen zu allem, was Sie mit Plugins tun können, finden Sie im Plugin-Entwicklungsleitfaden.

Beitrag zu Errbot selbst

Fühlen Sie sich frei, Änderungen auf Github zu forken und vorzuschlagen