desktop-notify

Release 1.3.3

Util for sending desktop notifications over dbus.

Homepage PyPI

License
MIT
Install
pip install desktop-notify==1.3.3

Documentation

dnotify

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

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

Stats

Dependencies
1
Dependent packages
4
Dependent repositories
0
Total releases
7
Latest release
First release
Stars
0
Forks
0
Contributors
0
SourceRank
10

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

1.3.3
1.3.2
1.3.1
1.2.1
1.2.0
1.1.3
1.1.1

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-03-11 14:06:44 UTC

Login to resync this project