Python module to trigger OS-agnostic notification/messagebox
Project description
Platform Supported
Deployments
PyNotification
Python module to trigger OS-agnostic notification/messagebox.
Installation
python -m pip install pynotification
Usage
from pynotification import pynotifier
pynotifier(title="Test title", message="Test message")
Optional arguments
- dialog: Boolean flag to trigger notification as a dialog in a popup window. Blocks process until user has pressed
OK
- icon: Custom icon to be used for
Linux
andWindows
operating systems.- Linux: Choose any pre-defined icons or a
.png
file as icon. - Windows: Choose any
.ico
file as icon. Defaults to notification.ico
- Linux: Choose any pre-defined icons or a
- destroy: Boolean value to destroy the notification box on
Windows
operating system after notifying. - debug: Display logs in the form of
info
,warnings
anderrors
messages. - logger: Bring your own
Logger
for custom logging.
Coding Standards
Docstring format: Google
Styling conventions: PEP 8
Clean code with pre-commit hooks: flake8
and
isort
Release Notes
Requirement
python -m pip install gitverse
Usage
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
Linting
PreCommit
will ensure linting, and the doc creation are run on every commit.
Requirement
pip install sphinx==5.1.1 pre-commit recommonmark
Usage
pre-commit run --all-files
Pypi Package
https://pypi.org/project/pynotification/
Runbook
https://thevickypedia.github.io/pynotification/
License & copyright
© Vignesh Rao
Licensed under the MIT License