Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 1.15 KB

README.rst

File metadata and controls

57 lines (34 loc) · 1.15 KB

OneSignal Python SDK

A Python SDK for OneSignal (https://onesignal.com/). Documentation for OneSignal API is available at https://documentation.onesignal.com/reference

Obtaining User Rest API key and App REST API key

See details here https://documentation.onesignal.com/docs/accounts-and-keys

Installing dependencies

Create a VirtualEnv and install dependencies from requirements.txt by running (from the root):

> pip install -r requirements.txt

Setup

You can install the package by running

> python setup.py install

Once installed, to get started, you can do:

from onesignalsdk import one_signal_sdk
one_signal =  one_signal_sdk.OneSignalSdk(AUTH_TOKEN_HERE, YOUR_APP_ID)
one_signal.get_players(your_basic_auth_key)

Tests

Tests are located under /tests and these also kind of show some examples on how to use the library.

Running tests

Go to this directory /tests and then run

> py.test

Contributors