Skip to main content

JPush's officially supported Python client library

Project description

=======================
JPush API Python Client
=======================

JPush's officially supported Python client library for accessing JPush APIs.

JPush Rest API Documents: http://docs.jpush.io/server/rest_api_v3_push/

You can download the latest release file here: https://github.com/jpush/jpush-api-python-client/releases

------------
Installation
------------
To install jpush-api-python-client, simply:

$ sudo pip install jpush

or alternatively install via easy_install:

$ sudo easy_install jpush


or from source:

$ sudo python setup.py install

-------
Testing
-------
For running the tests, you need the standard `unittest` module, shipped
with Python.

To run jpush-api-python-client tests, simply:

$ nosetests tests/push tests/devices --verbosity=2

--------
Examples
--------
You can see more examples in https://github.com/jpush/jpush-api-python-client/blob/master/examples

Simple iOS Push
---------------
>>> import jpush as jpush
>>> from conf import app_key, master_secret
>>> _jpush = jpush.JPush(app_key, master_secret)
>>> push = _jpush.create_push()
>>> push.audience = jpush.all_
>>> ios_msg = jpush.ios(alert="Hello, IOS JPush!", badge="+1", sound="a.caf", extras={'k1':'v1'})
>>> android_msg = jpush.android(alert="Hello, android msg")
>>> push.notification = jpush.notification(alert="Hello, JPush!", android=android_msg, ios=ios_msg)
>>> push.options = {"time_to_live":86400, "sendno":12345,"apns_production":True}
>>> push.platform = jpush.platform("ios")
>>> push.send()


Get taglist
-----------------
>>> import jpush as jpush
>>> from conf import app_key, master_secret
>>> _jpush = jpush.JPush(app_key, master_secret)
>>> device = _jpush.create_device()
>>> device.get_taglist()

--------
Questions
--------
The best place to ask questions is our community site:
http://community.jpush.cn/

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

jpush-3.2.6.tar.gz (13.7 kB view details)

Uploaded Source

File details

Details for the file jpush-3.2.6.tar.gz.

File metadata

  • Download URL: jpush-3.2.6.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for jpush-3.2.6.tar.gz
Algorithm Hash digest
SHA256 127f07e3657bc3d9528a70828951df1ffe692c0e1cc3e085f54c87fbcefb7282
MD5 bcadb43eb5c3c3c23b71722f184c0166
BLAKE2b-256 7366be685f59b3acf67ab73c50b0b104fc2c6ac03f8fd080f6d4887cefe23cd9

See more details on using hashes here.

Supported by

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