This repository was archived by the owner on Nov 21, 2023. It is now read-only.
File tree 3 files changed +69
-6
lines changed
3 files changed +69
-6
lines changed Original file line number Diff line number Diff line change
1
+ OneSignal Python SDK
2
+ =====================
3
+
4
+ A Python SDK for OneSignal (https://onesignal.com/). Documentation for OneSignal API is available at
5
+ https://documentation.onesignal.com/docs/server-api-overview.
6
+
7
+ Obtaining User Rest API key and App REST API key
8
+ -------------------------------------------------
9
+
10
+ See details here https://documentation.onesignal.com/docs/server-api-overview
11
+
12
+ Installing dependencies
13
+ ------------------------
14
+
15
+ Create a VirtualEnv and install dependencies from requirements.txt by running (from the root):
16
+
17
+ ::
18
+
19
+ > pip install -r requirements.txt
20
+
21
+ Setup
22
+ ------
23
+
24
+ You can install the package by running
25
+
26
+ ::
27
+
28
+ > python setup.py install
29
+
30
+ Once installed, to get started, you can do:
31
+
32
+ ::
33
+
34
+ >>> import one_signal_sdk
35
+ >>> one_signal = one_signal_sdk.OneSignalSdk(YOUR_APP_ID, AUTH_TOKEN_HERE)
36
+ >>> one_signal.get_players(your_app_id, your_basic_auth_key)
37
+
38
+ Tests
39
+ ------
40
+
41
+ Tests are located under /tests and these also kind of show some examples on how to use the library.
42
+
43
+ Running tests
44
+ ---------------
45
+
46
+ Go to this directory /tests and then run
47
+
48
+ ::
49
+
50
+ > py.test
51
+
52
+ Contributors
53
+ -------------
54
+
55
+ - Zohaib Ijaz <zohaibijaz.qc@gmail.com>
56
+ - Waqas Younas <waqas.younas@gmail.com>
57
+
Original file line number Diff line number Diff line change
1
+ include README.rst
Original file line number Diff line number Diff line change 1
-
2
1
from setuptools import find_packages
3
2
from distutils .core import setup
4
3
4
+
5
+ def readme ():
6
+ with open ('README.rst' ) as f :
7
+ return f .read ()
8
+
5
9
setup (
6
- name = 'OneSignalSDK ' ,
7
- packages = find_packages (exclude = ['tests*' ]), # this must be the same as the name above
8
- version = '0.1.1 ' ,
10
+ name = 'OneSignalPythonSDK ' ,
11
+ packages = find_packages (exclude = ['tests*' ]),
12
+ version = '0.1' ,
9
13
description = 'A Python SDK for OneSignal (http://onesignal.com)' ,
14
+ long_description = readme (),
10
15
author = 'Waqas Younas, Zohaib Ijaz' ,
11
16
author_email = 'waqas.younas@gmail.com, mzohaib.qc@gmail.com' ,
12
- url = 'https://github.com/gettalent/one-signal-python-sdk' , # use the URL to the github repo
13
- keywords = ['onesignal' , 'onesignalsdk' , 'sdk' ], # arbitrary keywords
17
+ url = 'https://github.com/gettalent/one-signal-python-sdk' ,
18
+ keywords = ['onesignal' , 'onesignalsdk' , 'sdk' ],
14
19
install_requires = [
15
20
'requests' ,
16
21
'pytest'
You can’t perform that action at this time.
0 commit comments