wechat_notify

KO | EN

gitlite — search

#hacktoberfest #react #go #golang #android #machine-learning #docker #windows #awesome #awesome-list #vue #security #mcp #open-source

(★ 21)

a cli tool to inform you when certain task is done

wechat_notify Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WECHAT NOTIFY

Many scripts today may take a long time to run, such as deep learning tasks. We wonder to check the results immediately after its accomplishment but keeping an eye on the process is not desirable.

This project is aimed to notify you through WeChat when certain command is completed.

**update**: this package is now released. you can install via `pip3 install wechat-notify`.

## requirements

This package rely on `requests`.

```bash
pip3 install requests
```

### SERVER CHAN

This project rely on [SERVER CHAN](http://sc.ftqq.com/3.version) to push notifications to WeChat. Please follow the instructions on the website and **set your SCKEY to environment variable** as `SERVER_CHAN_TOKEN`.

Your command's output and error will be write to file `stdout` and `stderr` regardless of whether notification will be push or not.

## usage

```bash
notify [bash command]
```

Note that special chars of bash, such as `>`, need to be escaped so that the script can capture the corrent bash command. For example:

```bash
notify python train.py \> trail.log
```

## example

WECHAT_NOTIFY will push three kinds of notifications.

* [Success]: inform you [what command, start time, how long the command takes, last three lines of output(if exists)]

<img src='imgs/success.png' height=300>
* [Failed]: inform you [what command, start time, how long the command takes, last three lines of stderr(if exists)]

<img src='imgs/failed.png' height=300>
    
* [Keyboard Interrupt]: inform you [what command, start time, 'Keyboard Interrupt']

## TODO

- [ ] unit test
- [ ] Email support
- [ ] test on WeChat Work

wechat_notify

wechat_notify Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

wechat_notify

wechat_notify Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README