slack machine

Slack Maschine

Slack Machine ist ein einfaches, aber leistungsstarkes und ausziehbares Slack -Bot -Framework. Mehr als nur ein Bot, Slack Machine ist ein Framework, mit dem Sie Ihren Slack -Arbeitsbereich in ein Chatops -Kraftpaket entwickeln können. Slack Machine ist mit einem intuitiven Plugin -System erstellt, mit dem Sie Bots schnell erstellen können, aber auch eine einfache Codeorganisation ermöglichen. Ein Plugin kann so einfach aussehen:

 from machine . plugins . base import MachineBasePlugin
from machine . plugins . message import Message
from machine . plugins . decorators import respond_to


class DeploymentPlugin ( MachineBasePlugin ):
    """Deployments"""

    @ respond_to ( r"deploy (?P<application>w+) to (?P<environment>w+)" )
    async def deploy ( self , msg : Message , application , environment ):
        """deploy <application> <environment>: deploy application to target environment"""
        await msg . say ( f"Deploying { application } to { environment } " )

Veränderungen brechen

Unterstützung für Python 3.8 (V0.38.0)

Ab V0.38.0 wurde die Unterstützung für Python 3.8 fallen gelassen. Python 3.8 hat am Ende des Lebens am 2024-10-07 erreicht.

Merkmale

• Beginnen Sie mit der Minenkonfiguration
• Auf der OP der Slack-Events-API aufgebaut, um reibungslos auf Ereignisse in Semi-Echtzeit zu reagieren. Verwendet Socket -Modus, damit Ihr Bot nicht dem Internet ausgesetzt sein muss!
• Unterstützung für reichhaltige Interaktionen mithilfe der Slack -Web -API
• Hochrangige API für maximale Bequemlichkeit beim Erstellen von Plugins
• API auf niedriger Ebene für maximale Flexibilität
• Auf Asyncio aufgebaut, um eine gute Leistung zu gewährleisten, indem sie die Kommunikation mit Slack gleichzeitig behandeln

Plugin -API -Funktionen:

• Hören Sie zu und reagieren Sie auf einen regulären Ausdruck
• Antworten Sie auf Slash -Befehle
• Erfassen Sie Teile von Nachrichten, die in Ihren Funktionen als Variablen verwendet werden sollen
• Antworten Sie auf Nachrichten in Kanälen, Gruppen und Direktnachrichtenkonversationen
• Reagieren mit Reaktionen
• In Threads antworten
• Antworten Sie mit kurzlebigen Nachrichten
• Senden Sie DMS an einen beliebigen Benutzer
• Unterstützung für Blöcke
• Unterstützung für Nachrichtenanhänge [Vermächtnis?]
• Unterstützung für interaktive Elemente
• Unterstützung für Modale
• Hören Sie zu und antworten Sie auf jedes Slack -Ereignis, das von der Ereignis -API unterstützt wird
• Speichern und abrufen alle Arten von Daten im persistenten Speicher (derzeit Redis, Dynamodb, SQLite und In-Memory-Speicher werden unterstützt)
• Planen Sie Aktionen und Nachrichten
• Ausstrahlen und auf Ereignisse hören
• Helfen Sie Texte für Plugins

Bald kommen

• Unterstützung für Abkürzungen
• ... und noch viel mehr

Installation

Sie können Ihrem UV -Projekt Slack -Maschine hinzufügen, indem Sie ausgeführt werden:

uv add slack-machine

Oder fügen Sie es Ihrem Gedichtprojekt hinzu:

poetry add slack-machine

Zuletzt können Sie es mit PIP installieren (nicht empfohlen):

$ pip install slack-machine

Es wird dringend empfohlen , slack-machine in einer virtuellen Umgebung zu installieren!

Verwendung

1. Erstellen Sie ein Verzeichnis für Ihren Slack Machine Bot: mkdir my-slack-bot && cd my-slack-bot

2. Fügen Sie Ihrem BOT -Verzeichnis eine Datei local_settings.py hinzu: touch local_settings.py

3. Erstellen Sie eine neue App in Slack: https://api.slack.com/apps

4. Wählen Sie, um eine App aus einem App -Manifest zu erstellen

5. Das folgende Manifest kopieren/einfügen: manifest.yaml

6. Fügen Sie die Slack -App- und Bot -Token zu Ihrem local_settings.py wie folgt hinzu:

    SLACK_APP_TOKEN = "xapp-my-app-token"
   SLACK_BOT_TOKEN = "xoxb-my-bot-token"
   

7. Starten Sie den Bot mit slack-machine

8. ...

9. Profitieren!

Dokumentation

Hier finden Sie die Dokumentation für Slack-Maschine: https://donbonair.github.io/slack-machine/

Lesen Sie es, um zu erfahren, wie Sie Slack -Maschine richtig konfigurieren, Plugins schreiben und vieles mehr!

Es gibt auch ein Beispiel -Plugin, das viele der Funktionen von Slack Machine zeigt: Slack Machine KitchenSink Plugin