slurmworm
This is a rather simple tool to monitor SLURM emails and alert you via a telegram bot about your jobs.
Note! This is under heavy development!
Installation
- install imapclient directly from the github repo not pip
- clone this repo and run
python setup install
- create a directory
~/.config/slurmworm - in this directory you need to place two files.
-
- one is the telegram bot info for the your bot that you must create named
access.yml
- one is the telegram bot info for the your bot that you must create named
-
- the other is a UNIX conf file with your IMAP email info named
imap_monitor.iniwhich identifies the email account to which you will send slurm messages
- the other is a UNIX conf file with your IMAP email info named
Telegram bot setup
If you read the above guide to create your bot you will have nearly everything you need. You then need to get that info into your access.yml file:
token:
'<your bot ID token>'
chat_id:
'<the group ID where your bot will send messages>'
You should have your bot chat to a group you have created.
email setup
This is what should go in imap_monitor.ini:
[imap]
host = <your imap server>
username = <username>
password = <password>
ssl = True
folder = INBOX
[path]
download = <where mail will be temporarily stored>
Running
After you have installed and set everything up, just type
slurmworm
in a shell and it will run and monitor your email.
It is likely best to have this running in a tmux shell you can disconnect from.
May all your jobs exit 0!
Metadata
Release files for slurmworm 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| slurmworm-1.0.0.tar.gz | 23.6 kB | Details |
Release files / slurmworm-1.0.0.tar.gz
| Download URL | slurmworm-1.0.0.tar.gz |
|---|---|
| Size | 23.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
beec4b493399522a915a816a23bb7432512c9f14ff89e9d37334b1a3dafbed39
|
|
BLAKE2b-256 checksum How to use checksums |
fe888121e505d2c2bd081bfba3371cb100b485b0d7899daf5676ac3c4f17729a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
|