neuralib.tools.slack_bot

Module provide basic function for sending Slack messages with Python

1. Configure a Slack App

1.1. Create an app from https://api.slack.com/app

1.2. Find the “OAuth & Permissions” tab to open access (i.e., chat:write, chat:write.customize, files:read, files:write)

1.3. Click “Install to Workspace”

1.4. See token, which starts with xoxb-

1.5. In Slack, find the Apps tab on the left side to add the created app

2. Configure an env file

2.1. Put it in the repo as a (.env file), **DO NOT* control it with GIT (add to .gitignore)

2.2. The env file should contain two keys: SLACK_TOKEN (xoxb-*) and CHANNEL_ID to send the message

3. Call the function

from neuralib.tools.slack_bot import send_slack_message
env_file = ...  # env file path
send_slack_message(env_file, 'Hello, slack!')

neuralib.tools.slack_bot.send_slack_message(env_file, message)[source]

Send message to slack channel

Parameters:

env_file (str | Path | bytes | BinaryIO | BufferedIOBase | BufferedReader) – env file with fields SLACK_TOKEN (i.e., SLACK_TOKEN=xoxb-<USER_SLACK_TOKEN>), and CHANNEL_ID (i.e., #general or ID)
message (str) – message to send

Returns:

Return type:

None