Metadata-Version: 2.1
Name: pyntfy
Version: 0.2.0
Summary: A module for interacting with ntfy.sh notifications.
Home-page: https://github.com/DP44/pyntfy
Author: DP44
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/DP44/pyntfy/issues
Keywords: notification notify ntfy toast android
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE


# pyntfy

A module for interacting with [ntfy.sh](https://ntfy.sh/) notifications.

------------------------------------------------------------------  
### Installation
You can install pyntfy via pip.
```
$ pip install pyntfy
```

------------------------------------------------------------------  
### Usage
```py
import pyntfy

# Send a sample notification.
notif = pyntfy.Notification('test_notification', 'Hello, world!', title='Notification Title')
notif.send()

# Send a timed notification.
timed_notif = pyntfy.Notification('test_notification', 'Hello, world!', title='Notification Title', delay='1m')
timed_notif.send()
```

#### Actions
```py
import pyntfy
from pyntfy import actions

notif = pyntfy.Notification('test_actions', 'Hello, world!')
notif.add_action(actions.ViewAction('Label', 'https://www.example.com/'))
notif.send()
```

------------------------------------------------------------------  
### Planned Features
- Allow for JSON data as input.
- Proper tests.

<!-- TODO: README -->


