https://github.com/thevickypedia/pynotification
Python module to trigger system notifications on Linux, Windows and macOS
https://github.com/thevickypedia/pynotification
builtin-functions lightweight notifications-plugin os-agnostic python system-notifications
Last synced: 3 months ago
JSON representation
Python module to trigger system notifications on Linux, Windows and macOS
- Host: GitHub
- URL: https://github.com/thevickypedia/pynotification
- Owner: thevickypedia
- License: mit
- Created: 2023-01-09T16:26:09.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-29T23:21:01.000Z (about 2 years ago)
- Last Synced: 2025-03-15T13:18:12.777Z (7 months ago)
- Topics: builtin-functions, lightweight, notifications-plugin, os-agnostic, python, system-notifications
- Language: Python
- Homepage: https://pypi.org/project/pynotification/
- Size: 237 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Platform Supported**
**Deployments**
[](https://github.com/thevickypedia/pynotification/actions/workflows/pages/pages-build-deployment)
[](https://github.com/thevickypedia/pynotification/actions/workflows/python-publish.yml)
# PyNotification
Python module to trigger OS-agnostic notification/messagebox.
### Installation
```shell
python -m pip install pynotification
```
### Usage
```python
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` and `Windows` operating systems.
- Linux: Choose any [pre-defined icons](https://wiki.ubuntu.com/Artwork/BreatheIconSet/Icons) or a `.png` file as icon.
- Windows: Choose any `.ico` file as icon. Defaults to [notification.ico](https://github.com/thevickypedia/pynotification/tree/main/pynotification/notification.ico)
- **destroy:** Boolean value to destroy the notification box on `Windows` operating system after notifying.
- **debug:** Display logs in the form of `info`, `warnings` and `errors` messages.
- **logger:** Bring your own [`Logger`](https://docs.python.org/3/library/logging.html#logging.Logger) for custom logging.
## Coding Standards
Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/)
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
[`isort`](https://pycqa.github.io/isort/)
## [Release Notes](https://github.com/thevickypedia/pynotification/blob/main/release_notes.rst)
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
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**
```shell
pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[](https://packaging.python.org/tutorials/packaging-projects/)
[https://pypi.org/project/pynotification/](https://pypi.org/project/pynotification/)
## Runbook
[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
[https://thevickypedia.github.io/pynotification/](https://thevickypedia.github.io/pynotification/)
## License & copyright
© Vignesh Rao
Licensed under the [MIT License](https://github.com/thevickypedia/pynotification/blob/main/LICENSE)