Welcome to notify’s documentation!

notify

Build status Coverage Downloads Latest version Format Status License Support version

Notify process termination via email. It support Python 2.4 and later (Python 2.4 and Python 2.5 were manually tested, so it might not work).

Installation

Use pip like:

$ pip install notify

Additionally, if you would like to use a mail user agent which requires authentication, installing keyring is strongly recommended:

$ pip install keyring

Usage

  1. Running notify with the following command will start a setup wizard the first time.

    $ notify
    
  2. Follow the setup wizard instructions.

  3. Check with the following command (Only for Unix system)

    $ notify --check
    
  4. Sample usage of notify

    $ notify really_havy_process -a -b --options
    $ notify -t different@address.com really_havy_process -a -b --options
    

Indices and tables