11<h1 align =" center " >Welcome to @onesignal/python-onesignal 👋</h1 >
22<p >
3- <a href =" https://www.npmjs.com/package/@ onesignal/ python-onesignal " target =" _blank " >
4- <img alt="Version" src="https://img.shields.io/npm /v/@ onesignal/ python-onesignal.svg ">
3+ <a href =" https://pypi.org/project/ onesignal- python-api/ " target =" _blank " >
4+ <img alt="Version" src="https://img.shields.io/pypi /v/onesignal- python-api ">
55 </a >
66 <a href =" https://github.com/OneSignal/python-onesignal#readme " target =" _blank " >
77 <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
1414 </a >
1515</p >
1616
17- > OpenAPI client for python-onesignal
1817A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
1918
20- This Python package is automatically generated by the [ OpenAPI Generator] ( https://openapi-generator.tech ) project:
21-
2219- API version: 1.0.1
2320- Package version: 1.0.0
2421- Build package: org.openapitools.codegen.languages.PythonClientCodegen
25- For more information, please visit [ https://onesignal.com ] ( https://onesignal.com )
2622
2723## Requirements.
2824
@@ -39,25 +35,22 @@ You can also install directly from GitHub using:
3935``` sh
4036pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
4137```
42- (you may need to run ` pip ` with root permission: ` sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git ` )
4338
44- Then import the package :
45- ``` python
46- import onesignal
39+ You may need to run ` pip ` with root permission :
40+ ``` sh
41+ sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
4742```
48-
4943### Setuptools
5044
5145Install via [ Setuptools] ( http://pypi.python.org/pypi/setuptools ) .
5246
5347``` sh
5448python setup.py install --user
5549```
56- (or ` sudo python setup.py install ` to install the package for all users)
5750
58- Then import the package:
59- ``` python
60- import onesignal
51+ To install the package for all users :
52+ ``` sh
53+ sudo python setup.py install
6154```
6255
6356## Getting Started
@@ -69,7 +62,7 @@ import onesignal
6962
7063# See configuration.py for a list of all supported configuration parameters.
7164configuration = onesignal.Configuration(
72- app_key = " YOUR_APP_KEY"
65+ app_key = " YOUR_APP_KEY" ,
7366 user_key = " YOUR_USER_KEY"
7467)
7568
@@ -166,44 +159,7 @@ Class | Method | HTTP request | Description
166159 - [ UpdatePlayerTagsSuccessResponse] ( docs/UpdatePlayerTagsSuccessResponse.md )
167160
168161
169- ## Documentation For Authorization
170-
171-
172- ## app_key
173-
174- - ** Type** : Bearer authentication
175-
176-
177- ## user_key
178-
179- - ** Type** : Bearer authentication
180-
181-
182162## Author
183163
184164devrel@onesignal.com
185165
186-
187- # Troubleshooting
188- ## Notes for Large OpenAPI documents
189- <details >
190- <summary>Click to expand</summary>
191- If the OpenAPI document is large, imports in onesignal.apis and onesignal.models may fail with a
192- RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
193-
194- Solution 1:
195- Use specific imports for apis and models like:
196- - ` from onesignal.api.default_api import DefaultApi `
197- - ` from onesignal.model.pet import Pet `
198-
199- Solution 2:
200- Before importing the package, adjust the maximum recursion limit as shown below:
201- ```
202- import sys
203- sys.setrecursionlimit(1500)
204- import onesignal
205- from onesignal.apis import *
206- from onesignal.models import *
207- ```
208- </details >
209-
0 commit comments