1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
==================
Firebase Messaging
==================
.. image:: https://badge.fury.io/py/firebase-messaging.svg
:alt: PyPI Version
:target: https://badge.fury.io/py/firebase-messaging
.. image:: https://github.com/sdb9696/firebase-messaging/actions/workflows/ci.yml/badge.svg?branch=main
:alt: Build Status
:target: https://github.com/sdb9696/firebase-messaging/actions/workflows/ci.yml?branch=main
.. image:: https://coveralls.io/repos/github/sdb9696/firebase-messaging/badge.svg?branch=main
:alt: Coverage
:target: https://coveralls.io/github/sdb9696/firebase-messaging?branch=main
.. image:: https://readthedocs.org/projects/firebase-messaging/badge/?version=latest
:alt: Documentation Status
:target: https://firebase-messaging.readthedocs.io/?badge=latest
.. image:: https://img.shields.io/pypi/pyversions/firebase-messaging.svg
:alt: Py Versions
:target: https://pypi.python.org/pypi/firebase-messaging#
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 <https://github.com/MatthieuLemoine/push-receiver>`_.
See `this blog post <https://medium.com/@MatthieuLemoine/my-journey-to-bring-web-push-support-to-node-and-electron-ce70eea1c0b0>`_ for more details.
Converted to python by
`lolisamurai <https://github.com/Francesco149/push_receiver>`_
http decryption logic in decrypt.py by
`Martin Thomson <https://github.com/web-push-libs/encrypted-content-encoding>`_
|
