Skip to main content
https://github.com/Fatal1ty/aioapns/workflows/tests/badge.svg Requirements Status 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.5 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.

Metadata

Release files for aioapns 2.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 2.1
File Size Uploaded
aioapns-2.1.tar.gz 13.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aioapns 2.1
File Interpreter ABI Platform
aioapns-2.1-py3-none-any.whl Python 3 none any Details

Total release size: 26.2 kB

Release files / aioapns-2.1.tar.gz

Download URL aioapns-2.1.tar.gz
Size 13.1 kB
Tags Source
SHA-256 checksum
How to use checksums
2ce526910bc2514a84b8105abe80508526ceafc0097c89f86bbbc501f8666c99
BLAKE2b-256 checksum
How to use checksums
d9963710b67291400645c8a9618ae7e9cdea0b52fc789a4d2137e216c179a54b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

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

Download URL aioapns-2.1-py3-none-any.whl
Size 13.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
095a205ec08481a640ea85be1a85e4c1b26a43058a489ee7e48dcc13ab2d1d12
BLAKE2b-256 checksum
How to use checksums
44136c9d4ddc68bdadfcd40d79ec38c7e9ed810949582e25698a577f06a66321
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

Release history Release notifications | RSS feed

4.0

2 release files

3.3.1

2 release files

3.3

2 release files

3.2

2 release files

3.1

2 release files

3.0

2 release files

2.2

2 release files

This release

2.1 This release

2 release files

2.0.2

1 release file

2.0.1

1 release file

2.0

1 release file

1.12

1 release file

1.11

1 release file

1.10

1 release file

1.9.1

1 release file

1.9

1 release file

1.8

1 release file

1.7

1 release file

1.6.2

1 release file

1.6.1

1 release file

1.6

1 release file

1.5.2

1 release file

1.5.1

1 release file

1.5

1 release file

1.4

1 release file

1.3

1 release file

1.2

1 release file

1.1.1

1 release file

1.1

1 release file

1.0

1 release file

0.6

1 release file

0.5

1 release file

0.4.1

1 release file

0.4

1 release file

0.3

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page