Code Monkey home page Code Monkey logo

pyfcm's Introduction

PyFCM

version license

Python client for FCM - Firebase Cloud Messaging (Android, iOS and Web)

Firebase Cloud Messaging (FCM) is the new version of GCM. It inherits the reliable and scalable GCM infrastructure, plus new features. GCM users are strongly recommended to upgrade to FCM.

Using FCM, you can notify a client app that new email or other data is available to sync. You can send notifications to drive user reengagement and retention. For use cases such as instant messaging, a message can transfer a payload of up to 4KB to a client app.

For more information, visit: https://firebase.google.com/docs/cloud-messaging/

Links

Updates (Breaking Changes)

Installation ==========

Install using pip:

pip install pyfcm

OR

pip install git+https://github.com/olucurious/PyFCM.git

PyFCM supports Android, iOS and Web.

Features

  • All FCM functionality covered
  • Tornado support

Examples

Send notifications using the FCMNotification class

# Send to single device.
from pyfcm import FCMNotification

push_service = FCMNotification(service_account_file="<service-account-json-path>")

# OR initialize with proxies

proxy_dict = {
          "http"  : "http://127.0.0.1",
          "https" : "http://127.0.0.1",
        }
push_service = FCMNotification(service_account_file="<service-account-json-path>", proxy_dict=proxy_dict)

# Your service account file can be gotten from:  https://console.firebase.google.com/u/0/project/_/settings/serviceaccounts/adminsdk

fcm_token = "<fcm token>"
notification_title = "Uber update"
notification_body = "Hi John, your order is on the way!"
notification_image = "https://example.com/image.png"
result = push_service.notify(fcm_token=fcm_token, notification_title=notification_title, notification_body=notification_body, notification_image=notification_image)
print result

Send a data message

# With FCM, you can send two types of messages to clients:
# 1. Notification messages, sometimes thought of as "display messages."
# 2. Data messages, which are handled by the client app.
# 3. Notification messages with optional data payload.

# Client app is responsible for processing data messages. Data messages have only custom key-value pairs. (Python dict)
# Data messages let developers send up to 4KB of custom key-value pairs.

# Sending a notification with data message payload
data_payload = {
    "foo": "bar",
    "body": "great match!",
    "room": "PortugalVSDenmark"
}
# To a single device
result = push_service.notify(fcm_token=fcm_token, notification_body=notification_body, data_payload=data_payload)

# Sending a data message only payload, do NOT include notification_body also do NOT include notification body
# To a single device
result = push_service.notify(fcm_token=fcm_token, data_payload=data_payload)

# Use notification messages when you want FCM to handle displaying a notification on your app's behalf.
# Use data messages when you just want to process the messages only in your app.
# PyFCM can send a message including both notification and data payloads.
# In such cases, FCM handles displaying the notification payload, and the client app handles the data payload.

Appengine users should define their environment

push_service = FCMNotification(api_key="<service-account-json-path>", proxy_dict=proxy_dict, env='app_engine')
result = push_service.notify(fcm_token=fcm_token, notification_body=message)

Sending a message to a topic

# Send a message to devices subscribed to a topic.
result = push_service.notify(topic_name="news", notification_body=message)

# Conditional topic messaging
topic_condition = "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
result = push_service.notify(notification_body=message, topic_condition=topic_condition)
# FCM first evaluates any conditions in parentheses, and then evaluates the expression from left to right.
# In the above expression, a user subscribed to any single topic does not receive the message. Likewise,
# a user who does not subscribe to TopicA does not receive the message. These combinations do receive it:
# TopicA and TopicB
# TopicA and TopicC
# Conditions for topics support two operators per expression, and parentheses are supported.
# For more information, check: https://firebase.google.com/docs/cloud-messaging/topic-messaging

Other argument options

:

android_config (dict, optional): Android specific options for messages -
    https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidconfig

apns_config (dict, optional): Apple Push Notification Service specific options -
    https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#apnsconfig

webpush_config (dict, optional): Webpush protocol options -
    https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushconfig

fcm_options (dict, optional): Platform independent options for features provided by the FCM SDKs -
    https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#fcmoptions

dry_run (bool, optional): If `True` no message will be sent but
    request will be tested.

pyfcm's People

Contributors

olucurious avatar elpoisterio avatar lucashild avatar gizmopratik avatar hanksims avatar romantolkachyov avatar carrasti avatar fredericojordan avatar nghitran avatar sachaservan avatar dependabot[bot] avatar belegnar avatar suppliedorange avatar miksep avatar jorl17 avatar babus avatar drakedevel avatar rogalek avatar olgeni avatar godfreyduke avatar ghk829 avatar dooyeoung avatar baali avatar cvipul avatar stephen-kwong avatar searchdream avatar rohitchormale avatar rodrigorznd avatar mrlucascardoso avatar eliranmoyal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.