jpush 3.1.1

JPush's officially supported Python client library

.. image:: https://travis-ci.org/jpush/jpush-api-python-client.svg?branch=master
:target: https://travis-ci.org/jpush/jpush-api-python-client
.. image:: https://badge.fury.io/gh/jpush%2Fjpush-api-python-client.svg
:target: http://badge.fury.io/gh/jpush%2Fjpush-api-python-client
.. image:: https://badge.fury.io/py/jpush.svg
:target: http://badge.fury.io/py/jpush
.. image:: https://pypip.in/download/jpush/badge.svg
:target: https://pypi.python.org/pypi/jpush/
:alt: Downloads

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

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

JPush Rest API Documents: `http://docs.jpush.cn/display/dev/REST+API <http://docs.jpush.cn/display/dev/REST+API/>`_

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

------------
Dependencies
------------
You need to install requests, the python http library, to use jpush python client.

.. code-block:: sh

$ sudo pip install requests

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

.. code-block:: sh

$ sudo pip install jpush

or alternatively install via easy_install:

.. code-block:: sh

$ sudo easy_install jpush


or from source:

.. code-block:: sh

$ 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:

.. code-block:: sh

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

--------
Examples
--------
You can see more examples in `examples <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'})
>>> 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 Q&A site:
http://www.jpush.cn/qa/

--------
Thanks to
--------
`crystal-wei <https://github.com/crystal-wei>`_ for reporting the jpush-api-python-client issues;