aioapns - An efficient APNs Client Library for Python/asyncio

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

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

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

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

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

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='<KEY_ID>',
        team_id='<TEAM_ID>',
        topic='<APNS_TOPIC>',  # Bundle ID
        use_sandbox=False,
    )
    request = NotificationRequest(
        device_token='<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.

Metadata

Release files for aioapns 3.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aioapns 3.3.1
File	Size	Uploaded
aioapns-3.3.1.tar.gz	14.3 kB	Jul 5, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for aioapns 3.3.1
File	Interpreter	ABI	Platform	Reset
aioapns-3.3.1-py3-none-any.whl 14.6 kB Jul 5, 2024	Python 3	none	any	Details

Total release size: 28.9 kB

Release files / aioapns-3.3.1.tar.gz

Download URL	aioapns-3.3.1.tar.gz
Size	14.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`6df429729fe8101a45bbdcb0a20f0214618747c67990bea5d8eda7cd95da37dd`
BLAKE2b-256 checksum How to use checksums	`2ac74fcc1892bc27ed464bc5893617a9366f4868c3db8aa9330f220176e8f4d8`
Upload date	Jul 5, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.11.9`

Release files / aioapns-3.3.1-py3-none-any.whl

Download URL	aioapns-3.3.1-py3-none-any.whl
Size	14.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4227fe47e967e6e18cbe283dfcbd8d05b739f1e71ab05ff3f8f21a959252fc9c`
BLAKE2b-256 checksum How to use checksums	`78dca20f4dbfb3fe4a968a1394ef31285c9873efc741c953cd155859f07cbb06`
Upload date	Jul 5, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.11.9`