Metadata-Version: 2.4
Name: skip-onesignal-client
Version: 0.1.0
Summary: OneSignal API wrapper
Home-page: https://github.com/skip-pay/onesignal-client
Author: Radim Sückr, Skip Pay Developers
Author-email: developers@skippay.cz
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# OneSignal client

OneSignal client is a wrapper for the OneSignal API which allows you to send notifications to Android, iOS and Web App.

It is based on ![onesignal-notifications](https://github.com/Lanseuo/onesignal-notifications) library.

## Installation

```
pip install onesignal-client
```

## Usage

```python
from onesignal import OneSignalClient, SegmentNotification

client = OneSignal("MY_APP_ID", "MY_REST_API_KEY")
notification_to_all_users = SegmentNotification(
    contents={
        "en": "Hello from OneSignal-Notifications"
    },
    included_segments=[SegmentNotification.ALL]
)
client.send(notification_to_all_users)
```

## Development

> Contributions are welcome

```
pip install --editable .
```

run the tests

```
export ONESIGNAL_API_KEY="..."
export ONESIGNAL_REST_API_KEY="..."

pytest
```

### Docs

To edit the docs, change the folder and spin up the development server.

```
cd docs
npm install -g vuepress
vuepress dev
```

## Meta

Lucas Hild - [https://lucas-hild.de](https://lucas-hild.de)  
This project is licensed under the MIT License - see the LICENSE file for details
