Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nnsnodnb/kalyke
:toolbox: A library for interacting with APNs and VoIP using HTTP/2.
https://github.com/nnsnodnb/kalyke
apns liveactivity pip python voip
Last synced: 3 days ago
JSON representation
:toolbox: A library for interacting with APNs and VoIP using HTTP/2.
- Host: GitHub
- URL: https://github.com/nnsnodnb/kalyke
- Owner: nnsnodnb
- License: mit
- Created: 2019-05-05T11:04:23.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T04:27:53.000Z (7 months ago)
- Last Synced: 2024-04-12T12:11:53.836Z (7 months ago)
- Topics: apns, liveactivity, pip, python, voip
- Language: Python
- Homepage: https://pypi.org/project/kalyke-apns
- Size: 779 KB
- Stars: 15
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# kalyke
[](https://codeclimate.com/github/nnsnodnb/kalyke/maintainability)
[](https://github.com/psf/black)
[](https://codecov.io/gh/nnsnodnb/kalyke)
[](https://pypi.org/project/kalyke-apns)
[](https://pypi.org/project/kalyke-apns)
[](https://pypi.org/project/kalyke-apns)
[](https://pypi.org/project/kalyke-apns)
[](https://pypi.org/project/kalyke-apns)
[](https://pypi.org/project/kalyke-apns)
A library for interacting with APNs and VoIP using HTTP/2.
## Installation
kalyke requires python 3.9 or later.
```bash
$ pip install kalyke-apns
```
## Usage
### APNs
```python
import asyncio
from kalyke import ApnsClient, ApnsConfig, Payload, PayloadAlert
client = ApnsClient(
use_sandbox=True,
team_id="YOUR_TEAM_ID",
auth_key_id="AUTH_KEY_ID",
auth_key_filepath="/path/to/AuthKey_AUTH_KEY_ID.p8",
)
registration_id = "a8a799ba6c21e0795b07b577b562b8537418570c0fb8f7a64dca5a86a5a3b500"
payload_alert = PayloadAlert(title="YOUR TITLE", body="YOUR BODY")
payload = Payload(alert=payload_alert, badge=1, sound="default")
config = ApnsConfig(topic="com.example.App")
asyncio.run(
client.send_message(
device_token=registration_id,
payload=payload,
apns_config=config,
)
)
```
### LiveActivity
> [!NOTE]
> - The topic suffix must be `.push-type.liveactivity`.
> - `LiveActivityPayload.event` default value is `LiveActivityEvent.UPDATE`.
```python
import asyncio
from datetime import datetime
from kalyke import LiveActivityClient, LiveActivityApnsConfig, LiveActivityEvent, LiveActivityPayload, PayloadAlert
client = LiveActivityClient(
use_sandbox=True,
team_id="YOUR_TEAM_ID",
auth_key_id="AUTH_KEY_ID",
auth_key_filepath="/path/to/AuthKey_AUTH_KEY_ID.p8",
)
registration_id = "a8a799ba6c21e0795b07b577b562b8537418570c0fb8f7a64dca5a86a5a3b500"
payload_alert = PayloadAlert(title="YOUR TITLE", body="YOUR BODY")
payload = LiveActivityPayload(
alert=payload_alert,
badge=1,
sound="default",
timestamp=datetime.now(),
event=LiveActivityEvent.UPDATE,
content_state={
"currentHealthLevel": 100,
"eventDescription": "Adventure has begun!",
},
)
config = LiveActivityApnsConfig(
topic="com.example.App.push-type.liveactivity",
)
asyncio.run(
client.send_message(
device_token=registration_id,
payload=payload,
apns_config=config,
)
)
```
### VoIP
> [!NOTE]
> - The topic suffix must be `.voip`.
```python
import asyncio
from pathlib import Path
from kalyke import VoIPApnsConfig, VoIPClient
client = VoIPClient(
use_sandbox=True,
auth_key_filepath=Path("/") / "path" / "to" / "YOUR_VOIP_CERTIFICATE.pem",
)
registration_id = "a8a799ba6c21e0795b07b577b562b8537418570c0fb8f7a64dca5a86a5a3b500"
payload = {"key": "value"}
config = VoIPApnsConfig(
topic="com.example.App.voip",
)
asyncio.run(
client.send_message(
device_token=registration_id,
payload=payload,
apns_config=config,
)
)
```
## License
This software is licensed under the MIT License (See [LICENSE](LICENSE)).