slack machine

スラックマシン

Slackマシンは、シンプルでありながら強力で拡張可能なSlackボットフレームワークです。単なるボットではなく、Slack Machineは、Slack WorkspaceをChatops Powerhouseに開発するのに役立つフレームワークです。 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で終了に達しました。

特徴

• ミニナル構成を始めましょう
• Smi Realtimeでのイベントにスムーズに応答するために、Slack Events APIの上に構築されています。ソケットモードを使用して、ボットをインターネットに公開する必要がないようにします！
• Slack Web APIを使用した豊富な相互作用のサポート
• プラグインを構築する際に最大限の利便性のための高レベルAPI
• 柔軟性を最大にするための低レベルAPI
• Slackとの通信を同時に処理することにより、良いパフォーマンスを確保するために、Asyncioの上に構築されました

プラグインAPI機能：

• どんな正規表現でも聞いて応答します
• スラッシュコマンドに応答します
• 関数の変数として使用するメッセージの部分をキャプチャする
• チャネル、グループ、直接メッセージの会話のメッセージに応答する
• 反応で応答します
• スレッドで応答します
• 一時的なメッセージで応答します
• 任意のユーザーにDMSを送信します
• ブロックのサポート
• メッセージ添付ファイルのサポート[レガシー？]
• インタラクティブな要素のサポート
• モーダルのサポート
• イベントAPIでサポートされているスラックイベントを聞いて応答します
• 任意の種類のデータを永続的なストレージで保存および取得します（現在Redis、dynamodb、sqlite、およびインメモリストレージがサポートされています）
• アクションとメッセージをスケジュールします
• イベントを放出して聴きます
• プラグインのテキストをヘルプします

近日公開

• ショートカットのサポート
• ...そしてもっと

インストール

実行して、SlackマシンをUVプロジェクトに追加できます。

uv add slack-machine

または、詩プロジェクトに追加してください。

poetry add slack-machine

最後に、PIPを使用してインストールできます（推奨されません）：

$ pip install slack-machine

仮想環境にslack-machineをインストールすることを強くお勧めします！

使用法

1. Slackマシンボットのディレクトリを作成： 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マシンのドキュメントは、https：//dondebonair.github.io/slack-machine/で見つけることができます。

それを読んで、Slackマシンを適切に構成する方法、プラグインを書き込むなどを学んでください！

Slack Machine：Slack Machine Kitchensinkプラグインの多くの機能を紹介するプラグインの例もあります。