https://github.com/Fatal1ty/aioapns

An efficient APNs Client Library for Python/asyncio
https://github.com/Fatal1ty/aioapns

apns apple-push-notifications asyncio push-notifications python

Last synced: 13 days ago
JSON representation

An efficient APNs Client Library for Python/asyncio

• Host: GitHub
• URL: https://github.com/Fatal1ty/aioapns
• Owner: Fatal1ty
• License: apache-2.0
• Created: 2017-05-11T09:05:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T07:27:34.000Z (3 months ago)
• Last Synced: 2024-10-23T07:51:39.869Z (21 days ago)
• Topics: apns, apple-push-notifications, asyncio, push-notifications, python
• Language: Python
• Size: 117 KB
• Stars: 119
• Watchers: 7
• Forks: 50
• Open Issues: 16
• Metadata Files:
  • Readme: README.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
aioapns - An efficient APNs Client Library for Python/asyncio

=================================================================================

.. image:: https://github.com/Fatal1ty/aioapns/workflows/tests/badge.svg

   :target: https://github.com/Fatal1ty/aioapns/actions

.. image:: https://img.shields.io/pypi/v/aioapns.svg

    :target: https://pypi.python.org/pypi/aioapns

.. image:: https://img.shields.io/pypi/pyversions/aioapns.svg

    :target: https://pypi.python.org/pypi/aioapns/

.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg

    :target: https://opensource.org/licenses/Apache-2.0

**aioapns** is a library designed specifically for sending push-notifications to iOS devices

via Apple Push Notification Service. aioapns provides an efficient client through

asynchronous HTTP2 protocol for use with Python's ``asyncio``

framework.

aioapns requires Python 3.8 or later.

Performance

-----------

In my testing aioapns allows you to send on average 1.3k notifications per second on a single core.

Features

--------

* Internal connection pool which adapts to the current load

* Support for certificate and token based connections

* Ability to set TTL (time to live) for notifications

* Ability to set priority for notifications

* Ability to set collapse-key for notifications

* Ability to use production or development APNs server

* Support for basic HTTP-Proxies

Installation

------------

Use pip to install::

    $ pip install aioapns

Basic Usage

-----------

.. code-block:: python

    import asyncio

    from uuid import uuid4

    from aioapns import APNs, NotificationRequest, PushType

    async def run():

        apns_cert_client = APNs(

            client_cert='/path/to/apns-cert.pem',

            use_sandbox=False,

        )

        apns_key_client = APNs(

            key='/path/to/apns-key.p8',

            key_id='',

            team_id='',

            topic='',  # Bundle ID

            use_sandbox=False,

        )

        request = NotificationRequest(

            device_token='',

            message = {

                "aps": {

                    "alert": "Hello from APNs",

                    "badge": "1",

                }

            },

            notification_id=str(uuid4()),  # optional

            time_to_live=3,                # optional

            push_type=PushType.ALERT,      # optional

        )

        await apns_cert_client.send_notification(request)

        await apns_key_client.send_notification(request)

    loop = asyncio.get_event_loop()

    loop.run_until_complete(run())

License

-------

aioapns is developed and distributed under the Apache 2.0 license.