A library for interacting with APNs and VoIP using HTTP/2.
Project description
kalyke
A library for interacting with APNs and VoIP using HTTP/2.
Installation
kalyke requires python 3.9 or later.
$ pip install kalyke-apns
Usage
APNs
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 isLiveActivityEvent.UPDATE
.
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
.
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).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
kalyke_apns-1.0.3.tar.gz
(9.9 kB
view details)
Built Distribution
File details
Details for the file kalyke_apns-1.0.3.tar.gz
.
File metadata
- Download URL: kalyke_apns-1.0.3.tar.gz
- Upload date:
- Size: 9.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.12.2 Linux/6.2.0-1019-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8421a758e82a9cf631ad7bab3c2a73702c827a73e932ebaae9901bdf5b015d0 |
|
MD5 | eb1aa148440f4a57101cf8ecc15801b0 |
|
BLAKE2b-256 | 523247e2a122c6757e98538c83aebe56b35831a029929730b145dbe70364c84d |
File details
Details for the file kalyke_apns-1.0.3-py3-none-any.whl
.
File metadata
- Download URL: kalyke_apns-1.0.3-py3-none-any.whl
- Upload date:
- Size: 13.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.12.2 Linux/6.2.0-1019-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b43529c63e6c5fd4cdf37579f4b5a5ea5c546842f079401722dc80abf23a811 |
|
MD5 | 272568ebba2e562fd0a697c3b3c03921 |
|
BLAKE2b-256 | 385464c408646645caa6dad5ef0449a073118467d0ff9b2e301f783a11023814 |