Metadata-Version: 1.1
Name: aioapns
Version: 2.0.2
Summary: An efficient APNs Client Library for Python/asyncio
Home-page: https://github.com/Fatal1ty/aioapns
Author: Alexander Tikhonov
Author-email: random.gauss@gmail.com
License: Apache License, Version 2.0
Description: aioapns - An efficient APNs Client Library for Python/asyncio
        =================================================================================
        
        .. image:: https://travis-ci.org/Fatal1ty/aioapns.svg?branch=master
            :target: https://travis-ci.org/Fatal1ty/aioapns
        
        .. image:: https://requires.io/github/Fatal1ty/aioapns/requirements.svg?branch=master
             :target: https://requires.io/github/Fatal1ty/aioapns/requirements/?branch=master
             :alt: Requirements Status
        
        .. 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.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
        -----------
        
        .. 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='<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.
        
Platform: all
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 5 - Production/Stable
