slack machine

Slack Machine

Slack Machine - это простая, но мощная и расширяемая платформа Slack Bot. Slack Machine - это больше, чем просто бот, - это структура, которая поможет вам развить ваше рабочее пространство Slack в мощность Chatops. Slack Machine построена с интуитивно понятной системой плагинов, которая позволяет быстро создавать ботов, но также позволяет легко организации кода. Плагин может выглядеть так же просто, как это:

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

Нарушение изменений

Отсутствие поддержки Python 3.8 (v0.38.0)

По состоянию на V0.38.0 поддержка Python 3.8 была отброшена. Python 3.8 достиг конца жизни в 2024-10-07.

Функции

• Начните с конфигурацией мининалов
• Построенный на вершине API API Slack Events для беспрепятственного реагирования на события в полу в режиме реального времени. Использует режим сокета, чтобы ваш бот не должен был подвергаться воздействию Интернета!
• Поддержка богатых взаимодействий с помощью Slack Web API
• API высокого уровня для максимального удобства при строительстве плагинов
• API низкого уровня для максимальной гибкости
• Построен на вершине Asyncio, чтобы обеспечить хорошую производительность, одновременно обрабатывая связь со Slack

Функции API плагина:

• Слушать и ответьте на любое регулярное выражение
• Ответьте на команды Slash
• Захватить части сообщений, которые можно использовать в качестве переменных в ваших функциях
• Ответьте на сообщения в каналах, группах и прямых разговорах сообщений
• Ответить реакциями
• Ответьте в темах
• Ответьте эфемерными сообщениями
• Отправить DMS любому пользователю
• Поддержка блоков
• Поддержка вложений сообщений [Legacy?]
• Поддержка интерактивных элементов
• Поддержка модалей
• Слушайте и отвечайте на любое событие Slack, поддерживаемое API событий
• Хранить и извлечь любые данные в постоянном хранении (в настоящее время поддерживаются Redis, DynamoDB, SQLite и в памяти)
• Запланировать действия и сообщения
• Имитайте и слушайте события
• Помогите текстам для плагинов

Вскоре

• Поддержка ярлыков
• ... и гораздо больше

Установка

Вы можете добавить Slack Machine в свой УФ -проект, работая:

uv add slack-machine

или добавьте его в свой поэтический проект:

poetry add slack-machine

Наконец, вы можете установить его с помощью PIP (не рекомендуется):

$ pip install slack-machine

Настоятельно рекомендуется установить slack-machine в виртуальную среду!

Использование

1. Создайте каталог для вашего бота Slack Machine: mkdir my-slack-bot && cd my-slack-bot

2. Добавьте файл local_settings.py в свой каталог бота: touch local_settings.py

3. Создать новое приложение в Slack: https://api.slack.com/apps

4. Выберите создание приложения из манифеста приложения

5. Скопировать/вставьте следующий манифест: manifest.yaml

6. Добавьте приложение Slack и токены бот в ваш local_settings.py

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

7. Запустить бот с помощью slack-machine

8. ...

9. Выгода!

Документация

Вы можете найти документацию для Slack Machine здесь: https://dondebonair.github.io/slack-machine/

Перейдите, чтобы узнать, как правильно настроить машину Slack, записать плагины и многое другое!

Существует также пример плагина, который показывает многие функции Slack Machine: Slack Machine Cuthensink Plugin