Skip to main content

FCM/GCM push notification client

Reason this release was yanked:

Yanked due to compatability issues with protobuf compilations

Project description

PyPI Version Build Status Coverage Documentation Status Py Versions

A library to subscribe to GCM/FCM and receive notifications within a python application.

When should I use firebase-messaging ?

  • I want to receive push notifications sent using Firebase Cloud Messaging in a python application.

When should I not use firebase-messaging ?

  • I want to send push notifications (use the firebase SDK instead)

  • My application is running on a FCM supported platform (Android, iOS, Web).

Install

PyPi:

$ pip install firebase-messaging

Requirements

  • Firebase configuration to receive notifications

Usage

Must be run inside an asyncio event loop.

python:

from firebase_messaging import FcmPushClient, FcmRegisterConfig

def on_notification(obj, notification, data_message):
    # Do something with the notification
    pass

credentials = None  # Start off with none or load from previous save
def on_credentials_updated(creds):
    # save the credentials to a file here for future use

fcm_config = FcmRegisterConfig(fcm-project-id, fcm-app-id, fcm-api-key, fcm-message-sender-id)
pc = FcmPushClient(on_notification, fcm_config, credentials, on_credentials_updated)
fcm_token = await pc.checkin_or_register()

await pc.start()

# Adapt the following for your usage
while some_condition_to_keep_listening:
    asyncio.sleep(2)

Attribution

Code originally based on typescript/node implementation by Matthieu Lemoine. See this blog post for more details.

Converted to python by lolisamurai

http decryption logic in decrypt.py by Martin Thomson

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

firebase_messaging-0.4.2.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

firebase_messaging-0.4.2-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file firebase_messaging-0.4.2.tar.gz.

File metadata

  • Download URL: firebase_messaging-0.4.2.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for firebase_messaging-0.4.2.tar.gz
Algorithm Hash digest
SHA256 b094277054d1294ffa5aa290acd195adbe391c2a48809f6247d3aa9002ae3028
MD5 c84b788b75072aba79d681a0d0e9bc66
BLAKE2b-256 ec7406cea58399a228d878744ad1006fe0b8c16c181a699adb25e8392acb2890

See more details on using hashes here.

File details

Details for the file firebase_messaging-0.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for firebase_messaging-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 785b44aa883402bd3dea4537cb9f0784732d89ec1a086a6e628f6114e9b1182b
MD5 f768d251eb3c2866b9f8626936a74259
BLAKE2b-256 94dd33f527ff3a300313188ad25d1688e34f9638bbd46a878f8dee7b507281cf

See more details on using hashes here.

Supported by

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