Util for sending desktop notifications over dbus.
Project description
desktop_notify
Util for sending desktop notifications over dbus. Supports replace_id, hints and actions(mainloop required). Requires dbus-python.
Package usage
Basic notify:
notify = desktop_notify.aio.Notify('summary', 'body')
await notify.show()
notify = desktop_notify.glib.Notify('summary', 'body')
notify.set_on_show(callback) # optional
notify.show()
# or
notify.show_async()
Usage with server:
server = desktop_notify.aio.Server('app_name')
notify = server.Notify('summary')
await notify.show()
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(desktop_notify.Action('label', callback))
notify.del_action(desktop_notify.Action('label', callback))
Also supported on_show
and on_close
event:
notify.set_on_show(callback(notify))
notify.set_on_close(callback(notify, close_reason))
Console usage
usage: desktop-notify [--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:signature:value [key:signature:value ...], -h key:signature:value [key:signature:value ...]
use "--" to separate hints list from positional args
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
desktop-notify-1.3.1.tar.gz
(7.2 kB
view hashes)
Built Distribution
Close
Hashes for desktop_notify-1.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c926a9512daf70cc149f3591fe67f2bda2831e8c5c53856f09742f951a41b02a |
|
MD5 | 0fd9bafd1791e2106331235bb1247f8b |
|
BLAKE2b-256 | 41f18d1a7cf2ed002545f15c9fc2dd0c1d744d8c9c71fb233a8a21ff6c65832d |