==================
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 sender id to receive notification
- Firebase serverKey to send notification (optional)
Usage
-----
python::
from firebase_messaging import FcmPushClient
def on_notification(obj, notification, data_message):
# Do something with the notification
pass
pc = FcmPushClient(None)
fcm_token = pc.checkin(sender_id, app_id)
# Notify the service you're connecting to of your FCM token
pc.start(YOUR_NOTIFICATION_CALLBACK)
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>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/sdb9696/firebase-messaging",
"name": "firebase-messaging",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Firebase, Firebase Cloud Messaging, Google Cloud Messaging",
"author": "sdb9696",
"author_email": "steven.beth@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9d/cf/bfee121d1b9caf8e0e92f37ad9e26ebc6d2b0e15090ec72f55521efd5485/firebase_messaging-0.3.0.tar.gz",
"platform": null,
"description": "==================\nFirebase Messaging\n==================\n\n.. image:: https://badge.fury.io/py/firebase-messaging.svg\n :alt: PyPI Version\n :target: https://badge.fury.io/py/firebase-messaging\n\n.. image:: https://github.com/sdb9696/firebase-messaging/actions/workflows/ci.yml/badge.svg?branch=main\n :alt: Build Status\n :target: https://github.com/sdb9696/firebase-messaging/actions/workflows/ci.yml?branch=main\n\n.. image:: https://coveralls.io/repos/github/sdb9696/firebase-messaging/badge.svg?branch=main\n :alt: Coverage\n :target: https://coveralls.io/github/sdb9696/firebase-messaging?branch=main\n\n.. image:: https://readthedocs.org/projects/firebase-messaging/badge/?version=latest\n :alt: Documentation Status\n :target: https://firebase-messaging.readthedocs.io/?badge=latest\n\n.. image:: https://img.shields.io/pypi/pyversions/firebase-messaging.svg\n :alt: Py Versions\n :target: https://pypi.python.org/pypi/firebase-messaging#\n\nA library to subscribe to GCM/FCM and receive notifications within a python application.\n\nWhen should I use `firebase-messaging` ?\n----------------------------------------\n\n- I want to **receive** push notifications sent using Firebase Cloud Messaging in a python application.\n\nWhen should I not use `firebase-messaging` ?\n--------------------------------------------\n\n- I want to **send** push notifications (use the firebase SDK instead)\n- My application is running on a FCM supported platform (Android, iOS, Web).\n\nInstall\n-------\n\nPyPi::\n\n $ pip install firebase-messaging\n\n\nRequirements\n------------\n\n- Firebase sender id to receive notification\n- Firebase serverKey to send notification (optional)\n\nUsage\n-----\n\npython::\n\n from firebase_messaging import FcmPushClient\n\n def on_notification(obj, notification, data_message):\n # Do something with the notification\n pass\n\n pc = FcmPushClient(None)\n fcm_token = pc.checkin(sender_id, app_id)\n\n # Notify the service you're connecting to of your FCM token\n\n pc.start(YOUR_NOTIFICATION_CALLBACK)\n\n\nAttribution\n-----------\n\nCode originally based on typescript/node implementation by\n`Matthieu Lemoine <https://github.com/MatthieuLemoine/push-receiver>`_.\nSee `this blog post <https://medium.com/@MatthieuLemoine/my-journey-to-bring-web-push-support-to-node-and-electron-ce70eea1c0b0>`_ for more details.\n\nConverted to python by \n`lolisamurai <https://github.com/Francesco149/push_receiver>`_\n\nhttp decryption logic in decrypt.py by \n`Martin Thomson <https://github.com/web-push-libs/encrypted-content-encoding>`_\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "FCM/GCM push notification client",
"version": "0.3.0",
"project_urls": {
"Documentation": "http://firebase-messaging.readthedocs.io/",
"Homepage": "https://github.com/sdb9696/firebase-messaging",
"Repository": "https://github.com/sdb9696/firebase-messaging"
},
"split_keywords": [
"firebase",
" firebase cloud messaging",
" google cloud messaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c81c4ff7b08e217012af571ef99b3c9854939cd70cad0468686db33296b81704",
"md5": "8de93e6ea0fbb0e19062f58ab7eb3958",
"sha256": "a13fcd52e69316d0c9a8238a2df94d7a8c195883e83e8e89ed27a8815d70f5e0"
},
"downloads": -1,
"filename": "firebase_messaging-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8de93e6ea0fbb0e19062f58ab7eb3958",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 40804,
"upload_time": "2024-03-26T13:34:31",
"upload_time_iso_8601": "2024-03-26T13:34:31.704286Z",
"url": "https://files.pythonhosted.org/packages/c8/1c/4ff7b08e217012af571ef99b3c9854939cd70cad0468686db33296b81704/firebase_messaging-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9dcfbfee121d1b9caf8e0e92f37ad9e26ebc6d2b0e15090ec72f55521efd5485",
"md5": "8af71dc8d200c211b1626ade40f9edf5",
"sha256": "1f4ecd81d78da25ddb50842f04b7f4a13ee401341c0d3ea0c1bd8492ba067f3b"
},
"downloads": -1,
"filename": "firebase_messaging-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8af71dc8d200c211b1626ade40f9edf5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 37902,
"upload_time": "2024-03-26T13:34:32",
"upload_time_iso_8601": "2024-03-26T13:34:32.734455Z",
"url": "https://files.pythonhosted.org/packages/9d/cf/bfee121d1b9caf8e0e92f37ad9e26ebc6d2b0e15090ec72f55521efd5485/firebase_messaging-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 13:34:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sdb9696",
"github_project": "firebase-messaging",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "firebase-messaging"
}
JSON
