It also utilizes the pynzbget I wrote which simplifies NZBGet script development.
Notify NZBGet Script Details
Author: Chris Caron <firstname.lastname@example.org>
Current Version: 0.9.3
Release Date: Jul 19th, 2019
Source: GitHub / Direct Download Link
- Jul 19th, 2019 Update (v0.9.3):
- Python 3 Support Added
- Minor bug fixes
- Carrying supported packages dropped and replaced with a requirements.txt file
- Sep 9th, 2018 Update (v0.9.2):
- Added Windows Desktop Notification Support
- Minor bug fixes
- May 30th, 2018 Update (v0.9.1):
- Dropped Support for Notify My Android (NMA) as they've officially shut down.
- Kodi Notification Bugfix (images are now passed correctly to screen)
- Better Discord Markdown support
- Removed Notify My Android (as they officially shut down for good)
- Email plugin supports to= variable.
- Mar 11th, 2018 Update (v0.9.0):
- Feb 4th, 2018 Update (v0.8.0):
- Oct 29th, 2017 Update (v0.7.0):
- Jul 9th, 2017 Update (v0.6.1):
- Small bug fix for MatterMost Notifications users.
- Inline Configuration Check (users can test their settings now right from the NZB-Get configuration page)!
- Jul 5th, 2017 Update (v0.6.0):
- Jan 23rd, 2017 Update (v0.5.6):
Minor release just applying a few outstanding bug fixes.
- Sep 20th, 2016 Update (v0.5.5):
Minor release adding:
- Aug 5th, 2016 Update (v0.5.0):
New release which adds 2 new notification services
- July 19th, 2016 Update (v0.4.0): Minor release that just added support for SABnzbd.
The following needs to be ran in order to pull the packages this script depends on into your environment:
Code: Select all
# The requirements.txt can be found included in this package pip install -r requirements.txt
Popular Notification Services
The table below identifies the services this tool supports and some example service urls you need to use in order to take advantage of it.
- Boxcar | boxcar://
- Discord | discord://
- Dbus | dbus://, qt://, glib://, or kde://
- Email | mailto:// or mailtos://
- Emby | emby:// or embys://
- Faast | faast://
- Flock | flock://
- Gitter | gitter://
- Gnome | gnome://
- Gotify | gotify:// or gotifys://
- Growl | growl://
- IFTTT | ifttt://
- Join | join://
- KODI | kodi:// or kodis://
- Mailgun | mailgun://
- Matrix | matrix:// or matrixs://
- Mattermost | mmost://
- Microsoft Teams | msteams://
- Prowl | prowl://
- PushBullet | pbul://
- Pushjet | pjet:// or pjets://
- Pushed | pushed://
- Pushover | pover://
- Rocket.Chat | rocket:// or rockets://
- Ryver | ryver://
- Slack | slack://
- Telegram | tgram://
- Twist | twist://
- Twitter | twitter://
- XBMC | xbmc:// or xbmcs://
- XMPP | xmpp:// or xmpps://
- Windows Notification | windows://
- Webex Teams (Cisco) | wxteams://
- Zulip Chat | zulip://
- your_idea:// Got a suggestion?
SMS Notification Support
How does it work
It's pretty simple, you just use space and/or comma to delimit your servers you want to notify. Specify as many as you want and have as many notifications sent as you need.
The syntax works as follows:
For those who want Statistics to also be displayed inside their NZBGet Notifications, nzb-notify will support his too! This is done bu extracting information from an internal NZBGet RPC call it makes. IF you don't see the statistics, you may need to check to see that your (NZBGet) RPC Server is running and accepting connections (NZBGet out of the box has it already configured). If your not sure, just make sure you're listening on a local address in your Settings -> Security options of your configuration. Setting a TCP/IP address of 0.0.0.0 is the easiest way to ensure you won't have a problem.
Here are a few things it can do:
- Supports listing the downloaded files, displaying statistics, and/or displaying the log entries.
- Can act as a Queue-Script and notify you when something was just added to the queue.
- You can specify as many Push Notification servers as you want.
- Notification services that support HTML content can be notified as such.
- Notification services that support graphic images can display a fancy red (failure), green (success), or blue (info) image to enhance the user experience.
How Do I Make It Work?
It has gotten to be way to much effort to update this message board with all of the possible combinations of notifications. Especially now that there over 35+ of them. It's best to read the latest details here on how to formulate your own notification URL.
Most of my testing is done using the Command Line Interface I attached to it. For example a simple entry like this could send 'Hello World' to your XBMC server:
Code: Select all
python Notify.py -s xbmc://192.168.0.2 -t "Hello" -b "World!"
Code: Select all
Usage: Notify.py [options] Options: -h, --help show this help message and exit -s URL(s), --servers=URL(s) Specify 1 or more servers in their URL format ie: growl://mypass@localhost -t TITLE, --title=TITLE Specify the title of the notification message. -b BODY, --body=BODY Specify the body of the notification message. -i, --include_image Include image in message if the protocol supports it. -L FILE, --logfile=FILE Send output to the specified logfile instead of stdout. -D, --debug Debug Mode