Metadata-Version: 2.4
Name: notify-me
Version: 2.0
Summary: Notify the user when a job is done or failed
Home-page: https://github.com/mkalioby/notify-me
Author: Mohamed El-Kalioby
Author-email: mkalioby@mkalioby.com
Keywords: admin,utils,notification
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.30.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: requires-dist
Dynamic: summary

# notify-me

This program can run another program and notify you by SMTP email, Android push notification through [pushNotification](https://github.com/mkalioby/Python_Notifications) and/or internal notification server.

The internal notification server can be checked on Ubuntu/gnome, KDE or Mac OS X to get a notification, just choose the appropiate client from client folder.

iOS, Browsers and many other application are supported over [pushOver](https://pushover.net/). PushOver is a cheap service where the user buys a one-time (round $5) license for each platform.

The configuration parameters can be centeralized or customized per user.

## Installation of notification checker 

### Mac OS X

sudo gem install terminal-notifier

### Ubuntu/gnome
sudo pip install gi

## Options


 notify-me OPTIONS Command

 Options

    --notify-to=mail1,mail2    send an email when done to the following mails
    --notify-push              send a push notification
    --notify-OK=               send this message after success
    --notify-ERR=              send this message after failure
    --notify-topic=            the topic to send on if different than default queue
    --notify-name=             name of the job, to put it subject or push notifications
    --no-notify-send-out       don't send the stderr and stdout in the email.
    
 
 
 **Example**

 notify-me  --notify-to=someone@example.com,someone2@example.com --notify-push --notify-OK="System Updated" --notify-ERR="System Update Failed" --notify-name="System Update" --notify-topic="Admin" sudo apt-get upgrade

# Requirements

This is based on [pushNotification library](https://pypi.python.org/pypi?name=pushNotification), available on pip

# Installation

```sh
pip install pushNotification notify-me
```

# Configuration

You can configure the SMTP and push notification through /etc/notiy-me.cfg or ~/.notify-me.cfg

# Internal Notification Server Installation

Currently the server supports MySQL database as the back-end db. the server needs mod_python to work.

* Install Packages
```sh
$ sudo apt-get install libapache2-mod-python python-simplejson python-mysqldb
```
* Copy server code
```sh
	$ sudo cp SRC/server /var/www/notify
```
* Configure Apache in 000-default
```xml
	<Directory /var/www/notify/py>
         	SetHandler mod_python
                PythonHandler mod_python.publisher
        </Directory>
```

* Reload Apache
  
  ```sh 
 $ sudo service apache2 reload
 ```
 
* Configure Server, Edit the configuration in /var/www/notify/config.cfg
     



