Metadata-Version: 2.1
Name: py-notifier
Version: 0.3.1
Summary: Cross-platform desktop push-notifications.
Home-page: https://github.com/YuriyLisovskiy/pynotifier
Author: Yuriy Lisovskiy
Author-email: yuralisovskiy98@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Environment :: MacOS X
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pync (==2.0.3) ; platform_system == "Darwin"
Requires-Dist: win10toast (==0.9) ; platform_system == "Windows"


## Desktop Notifications

Simple Python3 module for displaying desktop notifications on Windows, Linux and MacOS.

### Installation
```bash
$ pip install py-notifier
```

### Requirements
#### Windows:
[`win10toast`](https://github.com/jithurjacob/Windows-10-Toast-Notifications) - Python module
#### Linux:
`libnotify-bin` CLI tool (manual installation is required). For Ubuntu run:
```bash
sudo apt-get install libnotify-bin
```
#### MacOS:
[`pync`](https://github.com/SeTeM/pync) - Python module

### Example
```python
from pynotifier import Notification

Notification(
	title='Notification Title',
	description='Notification Description',
	icon_path='/absolute/path/to/image/icon.png', # On Windows .ico is required, on Linux - .png
	duration=5,                                   # Duration in seconds
	urgency='normal'
).send()
```

### Development

```bash
$ make
ci               Lint and Test
clean            Remove Python file artifacts and virtualenv
lint             Lint source
test             Run tests
venv             Creates the virtualenv and installs tox
```

### Author
* [Yuriy Lisovskiy](https://github.com/YuriyLisovskiy)

### License
The project is licensed under the terms of the [MIT License](https://opensource.org/licenses/mit),
see the [LICENSE](LICENSE) file for more information.


