by kfdm

kfdm / gntp

GNTP Python Library - #growl #gntp

202 Stars 19 Forks Last release: Not found MIT License 221 Commits 10 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:


This is a Python library for working with the

Growl Notification
Transport Protocol 

It should work as a dropin replacement for the older Python bindings


You can install with pip


$ pip install gntp

then test the module


$ python -m gntp.notifier

Simple Usage


# GNTP uses the standard Python logging
import logging

import gntp.notifier

Simple "fire and forget" notification"Here's a quick message")

More complete example

growl = gntp.notifier.GrowlNotifier( applicationName = "My Application Name", notifications = ["New Updates","New Messages"], defaultNotifications = ["New Messages"], # hostname = "", # Defaults to localhost # password = "abc123" # Defaults to a blank password ) growl.register()

Send one message

growl.notify( noteType = "New Messages", title = "You have a new message", description = "A longer message description", icon = "", sticky = False, priority = 1, )

Try to send a different type of message

This one may fail since it is not in our list

of defaultNotifications

growl.notify( noteType = "New Updates", title = "There is a new update to download", description = "A longer message description", icon = "", sticky = False, priority = -1, )

URL based images do not work in the OSX version of

_ 1.4 You can send the image along with the notification to get around this.


image = open('/path/to/image.png', 'rb').read()
    noteType = "New Messages",
    title = "You have a new message",
    description = "This time we embed the image",
    icon = image,

.. note:: With Growl 2 and above user can choose to pass notification to system wide notifications center. In this case

argument would be ignored by the notification center (there would always be Growl icon instead).


GitHub issue tracker 


_ - Allow file:// scheme to be used for icons

_ - Fix bug with incoming password hash - Added info about license in each source file

_ - Fix bug with binary data (images) being encoded incorrectly

_ - Python 3.3 Support

_ - Remove duplicate code from gntp.config - Catch all errors and rethrow them as gntp.errors to make it easier for other programs to deal with errors from the gntp library. - Ensure that we open resource files as "rb" and update the documentation

_ - Fix a bug where resource sections were missing a CRLF - Fix a bug where the cli client was using config values over options - Add support for coalescing

_ - Support for images - Better test coverage support

_ - ConfigParser aware GrowlNotifier that reads settings from ~/.gntp

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.