Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Util for sending desktop notifications over dbus.

Project description

dnotify

Util for sending desktop notifications over dbus. Supports replace_id, hints and actions(mainloop required). Requires dbus-python.

Package usage

Create notify server:

server = dnotify.NotifyServer('app_name')

Create notify:

notify = server.Notify('summary')

Configure notify.

You can setnotify options by default property setter notify.body = 'body' or using fluent setters:

notify.set_id(0)\
	.set_icon('icon')\
	.set_timeout(10000) # ms

Extra options

Hints

For workings with hints use this methods:

notify.set_hint(key, value)
notify.get_hint(key)
notify.del_hint(key)

Actions

For using actions and event you need to specify notify server mainloop.

You can add or delete action:

notify.add_action(dnotify.Action('label', callback))
notify.del_action(dnotify.Action('label', callback))

Also supported on_close event:

notify.set_on_close(callback)

Mainloop

dbus-python supports glib and qt mainloops.

server = dnotify.NotifyServer('app_name')\
	set_mainloop(dnotify.MAINLOOOP_GLIB)\
	set_mainloop(dnotify.MAINLOOOP_QT)

Console usage

usage: dnotify [--help] [--icon ICON] [--id REPLACE_ID] [--timeout TIMEOUT]
               [--hints key:value [key:value ...]]
               Summary [Body]

Send desktop notification. Returns created notification's id.

positional arguments:
  Summary               The summary text briefly describing the notification.
  Body                  The optional detailed body text. Can be empty.

optional arguments:
  --help                show this help message and exit
  --icon ICON, -i ICON  The optional program icon of the calling application.
                        Should be either a file path or a name in a
                        freedesktop.org-compliant icon theme.
  --id REPLACE_ID       An optional ID of an existing notification that this
                        notification is intended to replace.
  --timeout TIMEOUT, -t TIMEOUT
                        The timeout time in milliseconds since the display of
                        the notification at which the notification should
                        automatically close.
  --hints key:value [key:value ...], -h key:value [key:value ...]
                        use "--" to separate hints list from positional args

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
dnotify-1.0.1-py3-none-any.whl (6.3 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page