Skip to main content

OneSignal API wrapper

Project description

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 library.

Installation

pip install onesignal-client

Usage

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
This project is licensed under the MIT License - see the LICENSE file for details

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onesignal-client-0.0.2.tar.gz (105.7 kB view details)

Uploaded Source

Built Distribution

onesignal_client-0.0.2-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file onesignal-client-0.0.2.tar.gz.

File metadata

  • Download URL: onesignal-client-0.0.2.tar.gz
  • Upload date:
  • Size: 105.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for onesignal-client-0.0.2.tar.gz
Algorithm Hash digest
SHA256 b090b80c207646166e99502615fd1ea1349e43efb4fd3dec2b0b2d67f295a27a
MD5 12ec10d299348cfffa21c2db2623b8e5
BLAKE2b-256 c6af301dc3235c411e0b301ef2c902f8ce3261c6f099a840bf037e71ba87497d

See more details on using hashes here.

File details

Details for the file onesignal_client-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: onesignal_client-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for onesignal_client-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7829e8e8acb995bd76cb7c58217a386c593a8e47b19265bbb77332fc7d1155ac
MD5 8bd8825d8701be337d23284483e6ca91
BLAKE2b-256 a3e77562f6b435282464d10928afc2e10d45d0d472dd14e10194c508ea0e3d7a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page