| Name | pynotification JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | Python module to trigger OS-agnostic notification/messagebox |
| upload_time | 2023-08-29 23:19:42 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3 |
| license | MIT License Copyright (c) 2023 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
system
notification
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
**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) <br>
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
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)
Raw data
{
"_id": null,
"home_page": "",
"name": "pynotification",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "system,notification",
"author": "",
"author_email": "Vignesh Sivanandha Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "**Platform Supported**\n\n\n\n**Deployments**\n\n[](https://github.com/thevickypedia/pynotification/actions/workflows/pages/pages-build-deployment)\n[](https://github.com/thevickypedia/pynotification/actions/workflows/python-publish.yml)\n\n# PyNotification\nPython module to trigger OS-agnostic notification/messagebox.\n\n### Installation\n```shell\npython -m pip install pynotification\n```\n\n### Usage\n```python\nfrom pynotification import pynotifier\n\npynotifier(title=\"Test title\", message=\"Test message\")\n```\n\n### Optional arguments\n- **dialog:** Boolean flag to trigger notification as a dialog in a popup window. Blocks process until user has pressed `OK`\n- **icon:** Custom icon to be used for `Linux` and `Windows` operating systems.\n - Linux: Choose any [pre-defined icons](https://wiki.ubuntu.com/Artwork/BreatheIconSet/Icons) or a `.png` file as icon.\n - Windows: Choose any `.ico` file as icon. Defaults to [notification.ico](https://github.com/thevickypedia/pynotification/tree/main/pynotification/notification.ico)\n- **destroy:** Boolean value to destroy the notification box on `Windows` operating system after notifying.\n- **debug:** Display logs in the form of `info`, `warnings` and `errors` messages.\n- **logger:** Bring your own [`Logger`](https://docs.python.org/3/library/logging.html#logging.Logger) for custom logging.\n\n## Coding Standards\nDocstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>\nStyling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>\nClean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and \n[`isort`](https://pycqa.github.io/isort/)\n\n## [Release Notes](https://github.com/thevickypedia/pynotification/blob/main/release_notes.rst)\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n`PreCommit` will ensure linting, and the doc creation are run on every commit.\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[](https://packaging.python.org/tutorials/packaging-projects/)\n\n[https://pypi.org/project/pynotification/](https://pypi.org/project/pynotification/)\n\n## Runbook\n[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)\n\n[https://thevickypedia.github.io/pynotification/](https://thevickypedia.github.io/pynotification/)\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License](https://github.com/thevickypedia/pynotification/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python module to trigger OS-agnostic notification/messagebox",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/pynotification/issues",
"Docs": "https://thevickypedia.github.io/pynotification/",
"Homepage": "https://github.com/thevickypedia/pynotification",
"Release Notes": "https://github.com/thevickypedia/pynotification/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/pynotification"
},
"split_keywords": [
"system",
"notification"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b47f71325975dec8d5c3dcd0e61e22b3b611025b79b52116648683d9e061b61",
"md5": "98372af9a4f9e5c672349731a1beb479",
"sha256": "5305b158e5f335d486ee6a66ebb7c54d9f1339627bfa4aa90f765376b3a2752e"
},
"downloads": -1,
"filename": "pynotification-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98372af9a4f9e5c672349731a1beb479",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 8558,
"upload_time": "2023-08-29T23:19:42",
"upload_time_iso_8601": "2023-08-29T23:19:42.861876Z",
"url": "https://files.pythonhosted.org/packages/4b/47/f71325975dec8d5c3dcd0e61e22b3b611025b79b52116648683d9e061b61/pynotification-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-29 23:19:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "pynotification",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pynotification"
}
