Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pr0ger/pyapns2
Python library for interacting with the Apple Push Notification service (APNs) via HTTP/2 protocol
https://github.com/pr0ger/pyapns2
apns apple python-library
Last synced: 3 days ago
JSON representation
Python library for interacting with the Apple Push Notification service (APNs) via HTTP/2 protocol
- Host: GitHub
- URL: https://github.com/pr0ger/pyapns2
- Owner: Pr0Ger
- License: mit
- Created: 2016-01-25T12:12:06.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T13:05:17.000Z (9 months ago)
- Last Synced: 2025-01-16T20:12:44.431Z (10 days ago)
- Topics: apns, apple, python-library
- Language: Python
- Homepage:
- Size: 112 KB
- Stars: 351
- Watchers: 10
- Forks: 179
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyAPNs2
[](https://pypi.python.org/pypi/apns2)
[](https://pypi.python.org/pypi/apns2)
[](https://drone.pr0ger.dev/Pr0Ger/PyAPNs2)
Python library for interacting with the Apple Push Notification service (APNs) via HTTP/2 protocol
## Installation
Either download the source from GitHub or use pip:
$ pip install apns2
## Sample usage
```python
from apns2.client import APNsClient
from apns2.payload import Payload
token_hex = 'b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b87'
payload = Payload(alert="Hello World!", sound="default", badge=1)
topic = 'com.example.App'
client = APNsClient('key.pem', use_sandbox=False, use_alternative_port=False)
client.send_notification(token_hex, payload, topic)
# To send multiple notifications in a batch
Notification = collections.namedtuple('Notification', ['token', 'payload'])
notifications = [Notification(payload=payload, token=token_hex)]
client.send_notification_batch(notifications=notifications, topic=topic)
# To use token based authentication
from apns2.credentials import TokenCredentials
auth_key_path = 'path/to/auth_key'
auth_key_id = 'app_auth_key_id'
team_id = 'app_team_id'
token_credentials = TokenCredentials(auth_key_path=auth_key_path, auth_key_id=auth_key_id, team_id=team_id)
client = APNsClient(credentials=token_credentials, use_sandbox=False)
client.send_notification_batch(notifications=notifications, topic=topic)
```
## Further Info
[iOS Reference Library: Local and Push Notification Programming Guide][a1]
## Contributing
To develop PyAPNs2, check out the code and install dependencies. It's recommended to use a virtualenv to isolate dependencies:
```shell
# Clone the source code.
git clone https://github.com/Pr0Ger/PyAPNs2.git
cd PyAPNs2
# Create a virtualenv and install dependencies.
virtualenv venv
. venv/bin/activate
pip install -e .[tests]
```
To run the tests:
```shell
pytest
```
You can use `tox` for running tests with all supported Python versions:
```shell
pyenv install 3.5.6; pyenv install 3.6.7; pyenv install 3.7.1; pyenv install 3.8.0
pyenv local 3.8.0 3.7.1 3.6.7 3.5.6
pip install tox
tox
```
To run the linter:
```shell
pip install pylint
pylint --reports=n apns2 test
```
## License
PyAPNs2 is distributed under the terms of the MIT license.
See [LICENSE](LICENSE) file for the complete license details.
[a1]:https://developer.apple.com/documentation/usernotifications?language=objc