slack machine

Máquina de folga

A Slack Machine é uma estrutura simples, mas poderosa e extensível, Slack Bot. Mais do que apenas um bot, o Slack Machine é uma estrutura que ajuda a transformar seu espaço de trabalho frouxo em uma potência do Chatops. O Slack Machine é construído com um sistema de plug -in intuitivo que permite criar bots rapidamente, mas também permite uma organização fácil de código. Um plugin pode parecer tão simples assim:

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

Quebrando mudanças

Suporte descartado para o Python 3.8 (v0.38.0)

A partir da v0.38.0, o suporte ao Python 3.8 foi descartado. O Python 3.8 atingiu o fim da vida em 2024-10-07.

Características

• Comece com a configuração mininal
• Construído em cima da API de eventos Slack para responder suavemente a eventos em semi-real em tempo real. Usa o modo de soquete para que seu bot não precise ser exposto à Internet!
• Suporte para interações ricas usando a API da Web Slack
• API de alto nível para máxima conveniência ao criar plugins
• API de baixo nível para máxima flexibilidade
• Construído em cima do Asyncio para garantir um bom desempenho, lidando com a comunicação com o Slack

Recursos da API do plug -in:

• Ouça e responda a qualquer expressão regular
• Responda aos comandos Slash
• Capture partes das mensagens para usar como variáveis ​​em suas funções
• Responda a mensagens em canais, grupos e conversas diretas de mensagens
• Responda com reações
• Responda em threads
• Responda com mensagens efêmeras
• Envie DMS para qualquer usuário
• Suporte para blocos
• Suporte para anexos de mensagens [legado?]
• Suporte para elementos interativos
• Suporte para modais
• Ouça e responda a qualquer evento de folga suportado pela API de eventos
• Armazene e recupere qualquer tipo de dados em armazenamento persistente (atualmente Redis, DynamoDB, SQLite e armazenamento na memória) são suportados)
• Agendar ações e mensagens
• Emiti e ouça para eventos
• Ajuda textos para plugins

Em breve

• Suporte para atalhos
• ... e muito mais

Instalação

Você pode adicionar o Slack Machine ao seu projeto UV executando:

uv add slack-machine

ou adicione -o ao seu projeto de poesia:

poetry add slack-machine

Por fim, você pode instalá -lo usando PIP (não recomendado):

$ pip install slack-machine

É fortemente recomendado que você instale slack-machine dentro de um ambiente virtual!

Uso

1. Crie um diretório para o seu Bot Slack Machine: mkdir my-slack-bot && cd my-slack-bot

2. Adicione um arquivo local_settings.py ao seu diretório de bot: touch local_settings.py

3. Crie um novo aplicativo no Slack: https://api.slack.com/apps

4. Escolha criar um aplicativo a partir de um manifesto de aplicativo

5. Copie/Cole o seguinte manifesto: manifest.yaml

6. Adicione o aplicativo Slack e os tokens de bot ao seu local_settings.py como este:

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

7. Comece o bot com slack-machine

8. ...

9. Lucro!

Documentação

Você pode encontrar a documentação para a Slack Machine aqui: https://dondebonair.github.io/slack-machine/

Vá ler para aprender a configurar corretamente a Slack Machine, escrever plugins e muito mais!

Há também um plugin de exemplo que mostra muitos dos recursos da Slack Machine: Slack Machine Kitchensink Plugin