Python bindings for the Growl Notification Transport Protocol
Bugs can be reported at the GitHub issue tracker
from gntp.notifier import mini
# Send a simple growl message with mostly default values
mini("Here's a quick message", callback="http://github.com/")
Single notification function
Simple notification function in one line. Has only one required parameter and attempts to use reasonable defaults for everything else :param string description: Notification message
Warning
For now, only URL callbacks are supported. In the future, the callback argument will also support a function
Helper class to simplfy sending Growl messages
Parameters: |
|
---|
The GrowlNotifier class is intended to mostly mirror the older python bindings for growl
Send GNTP Registration
Warning
Before sending notifications to Growl, you need to have sent a registration message at least once
Send a GNTP notifications
Warning
Must have registered with growl beforehand or messages will be ignored
Parameters: |
|
---|
Warning
For now, only URL callbacks are supported. In the future, the callback argument will also support a function
Send a Subscribe request to a remote machine
import gntp.notifier
# Simple "fire and forget" notification
gntp.notifier.mini("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 = "computer.example.com", # 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 = "http://example.com/icon.png",
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 = "http://example.com/icon.png",
sticky = False,
priority = -1,
)
# Send the image with the growl notification
image = open('/path/to/icon.png', 'rb').read()
growl.notify(
noteType = "New Messages",
title = "Now with icons",
description = "This time we attach the image",
icon = image,
)