Slack DM notifications for SGE jobs and Python computations on SGE-based clusters, plus Slack slash commands for server and queue status checks (/qq, /qstat, /gpu, /nvidia-smi).
miraeping contains two separate workflows:
| Workflow | What it is | Where to start |
|---|---|---|
| Job notifications | User-side Slack DM alerts from SGE job scripts or Python code | User Guide |
| Slack cluster commands | Optional slash commands such as /qq, /qstat, /qwd, /gpu, /nvidia-smi. A lab/admin server operator must run the command server first |
User Guide for usage, Developer Guide for setup |
Choose one path depending on how you use miraeping:
- Bash helper for SGE job scripts (
miraeping_send,miraeping_monitor,miraeping_stop): usegit clone+setup.sh - Python package API (
import miraeping): install from PyPI inside yourcondaoruvenvironment
- Find your Slack member ID: Slack → Profile → three-dot menu → Copy member ID
- Send it to your lab admin to get registered, and receive
SLACK_BOT_TOKEN
git clone https://github.com/kangmg/miraeping
cd miraeping
bash setup.sh
source ~/.bashrcsetup.sh prompts for SLACK_BOT_TOKEN and SLACK_USER_ID (masked input), installs the bash helper to ~/.miraeping/miraeping, and writes credentials to ~/.miraeping/credentials (chmod 600).
# conda example
conda create -n miraeping python=3.11 -y
conda activate miraeping
pip install miraeping
# uv example
uv venv -p 3.11 .venv
uv pip install miraepingUses Socket Mode — outbound WebSocket to Slack, no public IP or port forwarding needed.
uv venv -p 3.11 .venv
uv pip install "miraeping[server]"
export SLACK_BOT_TOKEN="xoxb-..."
export SLACK_APP_TOKEN="xapp-..."
miraeping-slack-serveBackground:
miraeping-slack-start
miraeping-slack-status
miraeping-slack-restart
miraeping-slack-stop- User Guide — setup, bash helper, Python API, slash commands
- Developer Guide — create Slack app, run command server, register users