Metadata-Version: 2.1
Name: onesignal-client
Version: 0.0.2
Summary: OneSignal API wrapper
Home-page: https://github.com/radimsuckr/onesignal-client
Author: Radim Sückr
Author-email: contact@radimsuckr.cz
License: MIT
Platform: UNKNOWN
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
Requires-Dist: requests

# 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


