Metadata-Version: 1.0
Name: python-gcm
Version: 0.1.5
Summary: Python client for Google Cloud Messaging for Android (GCM)
Home-page: http://blog.namis.me/python-gcm/
Author: Minh Nam Ngo
Author-email: nam@namis.me
License: Copyright (c) 2012 Minh Nam Ngo.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Description: python-gcm
        ======================
        [![Build Status](https://secure.travis-ci.org/geeknam/python-gcm.png?branch=master)](http://travis-ci.org/geeknam/python-gcm)
        
        Python client for Google Cloud Messaging for Android (GCM)
        
        Installation
        -------------
        ```bash
        pip install python-gcm
        ```
        
        Features
        ------------
        * Supports multicast message
        * Resend messages using exponential back-off
        * Proxy support
        * Easily handle errors
        
        Usage
        ------------
        RTFM [here](http://developer.android.com/guide/google/gcm/gcm.html)
                
        Basic
        ```python
        from gcm import GCM
        
        gcm = GCM(API_KEY)
        data = {'param1': 'value1', 'param2': 'value2'}
        
        # Plaintext request
        reg_id = '12'
        gcm.plaintext_request(registration_id=reg_id, data=data)
        
        # JSON request
        reg_ids = ['12', '34', '69']
        response = gcm.json_request(registration_ids=reg_ids, data=data)
        
        # Extra arguments
        res = gcm.json_request(
            registration_ids=reg_ids, data=data,
            collapse_key='uptoyou', delay_while_idle=True, time_to_live=3600
        )
        ```
        
        Error handling
        ```python
        # Plaintext request
        reg_id = '12345'
        try:
            canonical_id = gcm.plaintext_request(registration_id=reg_id, data=data)
            if canonical_id:
                # Repace reg_id with canonical_id in your database
                entry = entity.filter(registration_id=reg_id)
                entry.registration_id = canonical_id
                entry.save()
        except GCMNotRegisteredException:
            # Remove this reg_id from database
            entity.filter(registration_id=reg_id).delete()
        except GCMUnavailableException:
            # Resent the message
        
        # JSON request
        reg_ids = ['12', '34', '69']
        response = gcm.json_request(registration_ids=reg_ids, data=data)
        
        # Handling errors
        if 'errors' in response:
            for error, reg_ids in response['errors'].items():
                # Check for errors and act accordingly
                if error is 'NotRegistered':
                    # Remove reg_ids from database
                    for reg_id in reg_ids:
                        entity.filter(registration_id=reg_id).delete()
        if 'canonical' in response:
            for reg_id, canonical_id in response['canonical'].items():
                # Repace reg_id with canonical_id in your database
                entry = entity.filter(registration_id=reg_id)
                entry.registration_id = canonical_id
                entry.save()
        ```
        
        Exceptions
        ------------
        Read more on response errors [here](http://developer.android.com/guide/google/gcm/gcm.html#success)
        
        
        * GCMMalformedJsonException
        * GCMConnectionException
        * GCMAuthenticationException
        * GCMTooManyRegIdsException
        * GCMNoCollapseKeyException
        * GCMInvalidTtlException
        * GCMMissingRegistrationException
        * GCMMismatchSenderIdException
        * GCMNotRegisteredException
        * GCMMessageTooBigException
        * GCMInvalidRegistrationException
        * GCMUnavailableException
        
        ![Gotta catch them all](http://t.qkme.me/35gjhs.jpg)
        
Keywords: android gcm push notification google cloud messaging
Platform: UNKNOWN
