Metadata-Version: 2.4
Name: qtoggleserver-pushover
Version: 1.5.1
Summary: PushOver notifications for qToggleServer
Author-email: Calin Crisan <ccrisan@gmail.com>
License: Apache 2.0
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: aiohttp
Dynamic: license-file

## About

This is an addon for [qToggleServer](https://github.com/qtoggle/qtoggleserver).

It provides push notifications for qToggleServer via [Pushover](https://pushover.net/).


## Install

Install using pip:

    pip install qtoggleserver-pushover


## Usage

You'll need to register your account on [Pushover](https://pushover.net/), if you haven't done it yet. On their home
page, you'll see your *User Key*; copy it and use it in the configuration below. You can add more than one user key, if
you plan to send notifications to multiple users.

Then, you'll need a registered Pushover application (you can register one [here](https://pushover.net/apps/build)).
Copy the API key and use it in the configuration below:


##### `qtoggleserver.conf:`
``` ini
...
event_handlers = [
    ...
    {
        driver = "qtoggleserver.pushover.PushoverEventHandler"
        user_keys = ["r7zxs1nj20w86bghyub5div8jyzyiw"]
        api_key = "nwn1cmgc9m6sjhrv1o4roebpb31b5i"
        sound = "pushover"  # optional
        ...
    }
    ...
]
...
```

For further customization, see
[Template Notifications](https://github.com/qtoggle/qtoggleserver/wiki/Template-Notifications).

For advanced event filtering, see
[Filter Event Handlers](https://github.com/qtoggle/qtoggleserver/wiki/Filter-Event-Handlers).

For available Pushover sounds, see [Pushover Sounds](https://pushover.net/api#sounds).
