Skip to main content

FCM/GCM push notification client

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.4.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

firebase_messaging-0.4.4-py3-none-any.whl (40.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: firebase_messaging-0.4.4.tar.gz
  • Upload date:
  • Size: 39.4 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.4.tar.gz
Algorithm Hash digest
SHA256 b9593e2340442a08a4c3641dacbc54a1e688431027d2fd63a7e92efe3ec11ae8
MD5 ec158019d19d25a42747b08e93c06550
BLAKE2b-256 209e038c82e44bebfac9f865e9ca249a6c1bea382fd7fd6c409543fb89133b3b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for firebase_messaging-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 43aa4bd9014674006ec0462464b2caa85f70f7a8c19c407ba618b15bc8d6ff0f
MD5 14ffda50964616a44311fabe5ad1a128
BLAKE2b-256 0bc1c48b37bf53b908a6fe7c98282729762d0505077ce28306543c0e879c1a00

See more details on using hashes here.

Provenance

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