slack machine

Máquina de floja

Slack Machine es un marco Slack Bot simple, potente y extensible. Más que una máquina Bot, Slack Machine es un marco que lo ayuda a desarrollar su espacio de trabajo Slack en una potencia de Chatops. Slack Machine está construido con un sistema de complementos intuitivo que le permite construir bots rápidamente, pero también permite una organización de código fácil. Un complemento puede verse tan simple como este:

 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 } " )

Cambios de ruptura

Soporte caído para Python 3.8 (V0.38.0)

A partir de V0.38.0, se ha eliminado el soporte para Python 3.8. Python 3.8 ha alcanzado el final de la vida el 2024-10-07.

Características

• Comience con la configuración mininal
• Construido sobre la API de Slack Events para responder sin problemas a los eventos en tiempo semi en tiempo real. ¡Utiliza el modo de socket para que su bot no sea necesario expuestos a Internet!
• Soporte para interacciones ricas utilizando la API web Slack
• API de alto nivel para la máxima comodidad al construir complementos
• API de bajo nivel para la máxima flexibilidad
• Construido sobre Asyncio para garantizar un buen rendimiento al manejar la comunicación con Slack simultáneamente

Características de la API del complemento:

• Escuche y responda a cualquier expresión regular
• Responder a los comandos de corte
• Capturar partes de los mensajes para usar como variables en sus funciones
• Responda a mensajes en canales, grupos y conversaciones directas de mensajes
• Responder con reacciones
• Responder en hilos
• Responder con mensajes efímeros
• Enviar DMS a cualquier usuario
• Soporte para bloques
• Soporte para archivos adjuntos de mensajes [¿Legado?]
• Apoyo para elementos interactivos
• Soporte para modales
• Escuche y responda a cualquier evento de Slack compatible con la API de los eventos
• Almacene y recupere cualquier tipo de datos en el almacenamiento persistente (actualmente redis, DynamoDB, SQLite y almacenamiento en memoria son compatibles)
• Programar acciones y mensajes
• Emitir y escuchar eventos
• Ayuda textos para complementos

Muy pronto

• Soporte para atajos
• ... y mucho más

Instalación

Puede agregar una máquina Slack a su proyecto UV ejecutando:

uv add slack-machine

O agréguelo a su proyecto de poesía:

poetry add slack-machine

Por último, puede instalarlo usando PIP (no recomendado):

$ pip install slack-machine

¡Se recomienda encarecidamente que instale slack-machine dentro de un entorno virtual!

Uso

1. Crea un directorio para tu botón de máquina Slack: mkdir my-slack-bot && cd my-slack-bot

2. Agregue un archivo local_settings.py a su directorio BOT: touch local_settings.py

3. Crea una nueva aplicación en Slack: https://api.slack.com/apps

4. Elija crear una aplicación desde un manifiesto de la aplicación

5. Copiar/pegar el siguiente manifiesto: manifest.yaml

6. Agregue la aplicación Slack y los tokens de bot a su local_settings.py así:

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

7. Comience el bot con slack-machine

8. ...

9. ¡Ganancia!

Documentación

Puede encontrar la documentación para Slack Machine aquí: https://dondebonair.github.io/slack-machine/

¡Ve a leerlo para aprender a configurar correctamente la máquina Slack, escribir complementos y más!

También hay un complemento de ejemplo que muestra muchas de las características de Slack Machine: Slack Machine Kitchensink Plugin