aioapns - An efficient APNs Client Library for Python/asyncio
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.6 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
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.