mmpy_bot

Dokumentation verfügbar unter „Read the Docs“.

Beschreibung

Ein Python-basiertes Chat-Bot-Framework für Mattermost. Der Code für dieses Bot-Framework wurde in Version 2.0.0 stark überarbeitet und funktioniert nur mit Python 3.8 oder höher. Für die Unterstützung von Python 2 und Python3 < 3.8 verwenden Sie bitte die Versionen v1.3.9 oder niedriger.

Merkmale

• Basierend auf der Mattermost WebSocket API (V4.0.0)
• Einfacher Plugin-Mechanismus
• Gleichzeitige Nachrichtenverarbeitung
• Befestigungsunterstützung
• Automatische Wiederherstellung der Verbindung zu Mattermost nach Verbindungsverlust

Zusätzliche Funktionen, die in v2.x hinzugefügt wurden:

• Multithreading und asynchrone Ausführung
• Integrierter Webhook-Server
• Unterstützung für Klickfunktionen
• Auftragsplanung

Kompatibilität

Am wichtigsten	mmpy_bot
>= 4,0	> 1.2.0
< 4,0	nicht unterstützt

Installation

️ Warnung: pip greift auf v1.x zu, wenn Ihre Python-Version kleiner als 3.8 ist!

v2.x (aktuell)

 pip install mmpy-bot

v1.3.9 (Legacy erzwingen)

 pip install mmpy-bot==1.3.9

Nutzung (v2.x)

Anmeldung

Zuerst müssen Sie ein Bot-Konto auf Ihrem Mattermost-Server erstellen. Hinweis: „Bot-Kontoerstellung aktivieren“ muss in der Systemkonsole aktiviert sein

1. Melden Sie sich als Benutzer mit Administratorrechten bei Ihrem Mattermost-Server an.
2. Navigieren Sie zu Integrationen -> Bot-Konten -> Bot-Konto hinzufügen
3. Füllen Sie die Konfigurationsoptionen aus und notieren Sie sich bei der Erstellung das Zugriffstoken

Beachten Sie, dass einige API-Funktionen, wie z. B. kurzlebige Nachrichtenantworten, erfordern, dass der Bot Teil der Systemadministratorgruppe ist, die meisten API-Funktionen funktionieren jedoch mit einer regulären Mitgliedskontorolle . Beachten Sie jedoch, dass das Fehlen einiger API-Funktionen möglicherweise an einem Mangel an entsprechenden Berechtigungen liegt.

Konfigurieren Sie den Bot und führen Sie ihn aus

Erstellen Sie eine Einstiegspunktdatei (oder kopieren Sie die bereitgestellte), die Ihre Mattermost-Server- und Bot-Kontoeinstellungen definiert und die gewünschten Module importiert.

Beispiel my_bot.py :

 #!/usr/bin/env python

from mmpy_bot import Bot , Settings
from my_plugin import MyPlugin

bot = Bot (
    settings = Settings (
        MATTERMOST_URL = "http://chat.example.com" ,
        MATTERMOST_PORT = 443 ,
        BOT_TOKEN = "a69155mvlsobcnqpfdceqihaa" ,
        BOT_TEAM = "test" ,
        SSL_VERIFY = True ,
    ),  # Either specify your settings here or as environment variables.
    plugins = [ MyPlugin ()],  # Add your own plugins here.
)
bot . run ()

Setzen Sie das ausführbare Bit in der Einstiegspunktdatei (z. B. chmod +x my_bot.py ) und starten Sie Ihren Bot über die Eingabeaufforderung. Jetzt können Sie in Ihrem Mattermost-Client mit Ihrem Bot sprechen!

Um das Beste aus Ihrem Bot herauszuholen, müssen Sie Ihre eigenen Plugins schreiben. Weitere Informationen finden Sie in der Plugin-Dokumentation.

Sprechen Sie mit uns

Der primäre Kommunikationskanal ist GitHub über Issues oder Pull Requests, aber Sie können einige von uns auch auf Discord finden, um in Echtzeit zu interagieren.