Metadata-Version: 2.1
Name: onesignal-notifications
Version: 0.2.5
Summary: OneSignal API Wrapper for Python
Home-page: https://github.com/Lanseuo/onesignal-notifications
Author: Lucas Hild
Author-email: contact@lucas-hild.de
License: MIT
Description: # OneSignal-Notifications
        
        ![](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)
        [![PyPI](https://img.shields.io/pypi/v/onesignal-notifications.svg?style=flat-square&colorB=dfb317)](https://pypi.org/project/onesignal-notifications/)
        [![Docs](https://img.shields.io/badge/docs-VuePress-red.svg?style=flat-square)](https://lanseuo.github.io/onesignal-notifications/)
        [![Travis CI](https://img.shields.io/travis/Lanseuo/onesignal-notifications.svg?style=flat-square)](https://travis-ci.org/Lanseuo/onesignal-notifications)
        
        OneSignal-Notifications is a wrapper for the OneSignal API which allows you to send notifications to Android, iOS and Web App.
        
        ## Installation
        
        ```
        pip install onesignal-notifications
        ```
        
        ## Usage
        
        ```python
        from onesignal import OneSignal, 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
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
