Skip to main content

Flask-GCM is a simple wrapper for the python-gcm library to be used with Flask applications.

Project description

Flask-GCM

Build Status
Coverage Status
PyPI Version
PyPI Downloads

Flask-GCM is a simple wrapper for the `gcm-client <https://pypi.python.org/pypi/gcm-client/>`__ library to be used with Flask applications.

Getting Started

Requirements

  • Python 2.6+ or Python 3.3+

Installation

Flask-GCM can be installed with pip:

$ pip install flask-gcm

or directly from the source code:

$ git clone https://github.com/MichiganLabs/flask-gcm.git
$ cd flask-gcm
$ python setup.py install

Basic Usage

from flask import Flask
from flask.ext.gcm import GCM

app = Flask(__name__)
gcm = GCM(app)

Flask-GCM also supports the Flask “app factory” paradigm using init_app:

from flask import Flask
from flask.ext.gcm import GCM

gcm = GCM()

def create_app():
    app = Flask(__name__)
    gcm.init_app(app)
    return app

The gcm object can then be used as described in the `gcm-client docs <http://gcm-client.readthedocs.org/en/latest/index.html>`__

For Contributors

Installation

Create a virtualenv:

$ make env

Run the tests:

$ make test

Build the documentation:

$ make doc

Run static analysis:

$ make flake8
$ make pep257
$ make check  # includes all checks

Pull Request Guidelines

Contributions are always welcome! Please keep the following in mind when creating a pull request:

  • Include (passing) tests for all new features and bugfixes
  • Contributed code should pass flake8 checks
  • Include documentation which passes pep257 guidelines

Changelog

0.0.1 (2014/10/13)

  • Initial release

Project details


Download files

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

Files for Flask-GCM, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size Flask_GCM-0.2.0-py2-none-any.whl (6.8 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size Flask_GCM-0.2.0-py3-none-any.whl (6.8 kB) File type Wheel Python version 3.4 Upload date Hashes View
Filename, size Flask-GCM-0.2.0.tar.gz (4.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page