Skip to main content

An efficient Firebase Cloud Messaging Client Library for Python/asyncio

Project description

https://travis-ci.org/Fatal1ty/aiofcm.svg?branch=master https://img.shields.io/pypi/v/aiofcm.svg https://img.shields.io/pypi/pyversions/aiofcm.svg https://img.shields.io/badge/License-Apache%202.0-blue.svg

aiofcm is a library designed specifically for sending messages such as push-notifications to Android devices via Firebase Cloud Messaging platform. aiofcm provides an efficient client through asynchronous XMPP protocol for use with Python’s asyncio framework.

aiofcm requires Python 3.5 or later.

Performance

In my testing aiofcm allows you to send on average 1k messages per second on a single core.

Features

  • Internal connection pool which adapts to the current load

  • Sending notification and/or data messages

  • Ability to set TTL (time to live) for messages

  • Ability to set priority for messages

Installation

Use pip to install:

$ pip install aiofcm

Basic Usage

from uuid import uuid4
from aiofcm import FCM, Message, PRIORITY_HIGH


async def run():
    fcm = FCM('<NUMERICAL_SENDER_ID>', '<API_KEY>')
    message = Message(
        device_token='<DEVICE_TOKEN>',
        notification={           # optional
            "title": "Hello from Firebase",
            "body": "This is notification",
            "sound": "default"
        },
        data={"score": "3x1"},   # optional
        message_id=str(uuid4())  # optional
        time_to_live=3,          # optional
        priority=PRIORITY_HIGH,  # optional
    )
    await fcm.send_message(message)

loop = asyncio.get_event_loop()
loop.run_until_complete(run())

License

aiofcm is developed and distributed under the Apache 2.0 license.

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

aiofcm-0.6.tar.gz (5.1 kB view details)

Uploaded Source

File details

Details for the file aiofcm-0.6.tar.gz.

File metadata

  • Download URL: aiofcm-0.6.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for aiofcm-0.6.tar.gz
Algorithm Hash digest
SHA256 3ccd1ef5926ecd63fcc284785baa0e854225f123750dd1cce71cb9fad2b10614
MD5 19876eb8e6ea5cacde0ba9ee62c8a5d3
BLAKE2b-256 dc1fae1c1d2bce630899c25f06e6856a7c7f3050a450d7975f2444cce53b8283

See more details on using hashes here.

Supported by

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