# 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)).
Raw data
{
"_id": null,
"home_page": "https://github.com/nnsnodnb/kalyke",
"name": "kalyke-apns",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "apns,voip,liveactivity,apns provider api,apple push notifications",
"author": "Yuya Oka",
"author_email": "nnsnodnb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/52/32/47e2a122c6757e98538c83aebe56b35831a029929730b145dbe70364c84d/kalyke_apns-1.0.3.tar.gz",
"platform": null,
"description": "# kalyke\n\n\n[](https://codeclimate.com/github/nnsnodnb/kalyke/maintainability)\n[](https://github.com/psf/black)\n[](https://codecov.io/gh/nnsnodnb/kalyke)\n\n[](https://pypi.org/project/kalyke-apns)\n[](https://pypi.org/project/kalyke-apns)\n[](https://pypi.org/project/kalyke-apns)\n[](https://pypi.org/project/kalyke-apns)\n[](https://pypi.org/project/kalyke-apns)\n[](https://pypi.org/project/kalyke-apns)\n\nA library for interacting with APNs and VoIP using HTTP/2.\n\n## Installation\n\nkalyke requires python 3.9 or later.\n\n```bash\n$ pip install kalyke-apns\n```\n\n## Usage\n\n### APNs\n\n```python\nimport asyncio\n\nfrom kalyke import ApnsClient, ApnsConfig, Payload, PayloadAlert\n\nclient = ApnsClient(\n use_sandbox=True,\n team_id=\"YOUR_TEAM_ID\",\n auth_key_id=\"AUTH_KEY_ID\",\n auth_key_filepath=\"/path/to/AuthKey_AUTH_KEY_ID.p8\",\n)\n\nregistration_id = \"a8a799ba6c21e0795b07b577b562b8537418570c0fb8f7a64dca5a86a5a3b500\"\n\npayload_alert = PayloadAlert(title=\"YOUR TITLE\", body=\"YOUR BODY\")\npayload = Payload(alert=payload_alert, badge=1, sound=\"default\")\nconfig = ApnsConfig(topic=\"com.example.App\")\n\nasyncio.run(\n client.send_message(\n device_token=registration_id,\n payload=payload,\n apns_config=config,\n )\n)\n```\n\n### LiveActivity\n\n> [!NOTE]\n> - The topic suffix must be `.push-type.liveactivity`.\n> - `LiveActivityPayload.event` default value is `LiveActivityEvent.UPDATE`.\n\n```python\nimport asyncio\nfrom datetime import datetime\n\nfrom kalyke import LiveActivityClient, LiveActivityApnsConfig, LiveActivityEvent, LiveActivityPayload, PayloadAlert\n\nclient = LiveActivityClient(\n use_sandbox=True,\n team_id=\"YOUR_TEAM_ID\",\n auth_key_id=\"AUTH_KEY_ID\",\n auth_key_filepath=\"/path/to/AuthKey_AUTH_KEY_ID.p8\",\n)\n\nregistration_id = \"a8a799ba6c21e0795b07b577b562b8537418570c0fb8f7a64dca5a86a5a3b500\"\n\npayload_alert = PayloadAlert(title=\"YOUR TITLE\", body=\"YOUR BODY\")\npayload = LiveActivityPayload(\n alert=payload_alert,\n badge=1,\n sound=\"default\",\n timestamp=datetime.now(),\n event=LiveActivityEvent.UPDATE,\n content_state={\n \"currentHealthLevel\": 100,\n \"eventDescription\": \"Adventure has begun!\",\n },\n)\nconfig = LiveActivityApnsConfig(\n topic=\"com.example.App.push-type.liveactivity\",\n)\n\nasyncio.run(\n client.send_message(\n device_token=registration_id,\n payload=payload,\n apns_config=config,\n )\n)\n```\n\n### VoIP\n\n> [!NOTE]\n> - The topic suffix must be `.voip`.\n\n```python\nimport asyncio\nfrom pathlib import Path\n\nfrom kalyke import VoIPApnsConfig, VoIPClient\n\nclient = VoIPClient(\n use_sandbox=True,\n auth_key_filepath=Path(\"/\") / \"path\" / \"to\" / \"YOUR_VOIP_CERTIFICATE.pem\",\n)\n\nregistration_id = \"a8a799ba6c21e0795b07b577b562b8537418570c0fb8f7a64dca5a86a5a3b500\"\n\npayload = {\"key\": \"value\"}\nconfig = VoIPApnsConfig(\n topic=\"com.example.App.voip\",\n)\n\nasyncio.run(\n client.send_message(\n device_token=registration_id,\n payload=payload,\n apns_config=config,\n )\n)\n```\n\n## License\n\nThis software is licensed under the MIT License (See [LICENSE](LICENSE)).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for interacting with APNs and VoIP using HTTP/2.",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/nnsnodnb/kalyke",
"Repository": "https://github.com/nnsnodnb/kalyke"
},
"split_keywords": [
"apns",
"voip",
"liveactivity",
"apns provider api",
"apple push notifications"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "385464c408646645caa6dad5ef0449a073118467d0ff9b2e301f783a11023814",
"md5": "272568ebba2e562fd0a697c3b3c03921",
"sha256": "4b43529c63e6c5fd4cdf37579f4b5a5ea5c546842f079401722dc80abf23a811"
},
"downloads": -1,
"filename": "kalyke_apns-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "272568ebba2e562fd0a697c3b3c03921",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 13425,
"upload_time": "2024-02-22T19:20:20",
"upload_time_iso_8601": "2024-02-22T19:20:20.533040Z",
"url": "https://files.pythonhosted.org/packages/38/54/64c408646645caa6dad5ef0449a073118467d0ff9b2e301f783a11023814/kalyke_apns-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "523247e2a122c6757e98538c83aebe56b35831a029929730b145dbe70364c84d",
"md5": "eb1aa148440f4a57101cf8ecc15801b0",
"sha256": "f8421a758e82a9cf631ad7bab3c2a73702c827a73e932ebaae9901bdf5b015d0"
},
"downloads": -1,
"filename": "kalyke_apns-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "eb1aa148440f4a57101cf8ecc15801b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 9890,
"upload_time": "2024-02-22T19:20:22",
"upload_time_iso_8601": "2024-02-22T19:20:22.159295Z",
"url": "https://files.pythonhosted.org/packages/52/32/47e2a122c6757e98538c83aebe56b35831a029929730b145dbe70364c84d/kalyke_apns-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 19:20:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nnsnodnb",
"github_project": "kalyke",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "kalyke-apns"
}
JSON
