A simple package to send notifications to your devices using Firebase Cloud Messaging.
Project description
APNS Push Notification
This Python script allows you to send push notifications to Apple devices manually. It uses the Apple Push Notification service (APNS) to deliver notifications to your application users.
Why use initialize_apns?
The initialize_apns
function is used to set up the APNS with your application's specific details. This includes your key ID, team ID, bundle ID, and the path to your p8 or pem file. You can also specify whether you want to use the production or sandbox environment (default is sandbox).
How to use the script?
First, import the necessary modules:
import apns
Then, initialize the APNS with your application's details:
KEY_ID = ''
TEAM_ID = ''
BUNDLE_ID = 'com.test.app'
IS_PROD = False
P8_KEY_PATH = 'path/to/p8/key'
PEM_FILE_PATH = 'path/to/pem/file'
APNS_PRIORITY = 10
APNS_EXPIRATION = 0
apns.initialize_apns(key_id=KEY_ID,
team_id=TEAM_ID,
bundle_id=BUNDLE_ID,
is_prod=IS_PROD,
p8_key_path=P8_KEY_PATH,
pem_file_path=PEM_FILE_PATH,
apns_priority=APNS_PRIORITY,
apns_expiration=APNS_EXPIRATION)
apns.apns_config().verbose = True
Now, you can send a push notification:
device_token = ""
data = {}
title = "Hello World!"
response: APNSResponse = apns.push(device_token=device_token, title=title, data=data, badge=1, push_type=apns.PushType.alert, collapse_id=None)
Using p8 or pem file
Depending on your preference or requirements, you can use either a p8 or pem file for authentication. If you want to use a p8 file, pass the path to the p8_key_path
parameter in the initialize_apns
function. If you want to use a pem file, pass the path to the pem_file_path
parameter.
Getting a p8 file or pem file
To get the p8 or pem file for APNS push notification, you can follow these steps:
-
For p8 file:
- Go to the Apple Developer Portal.
- Navigate to the "Certificates, Identifiers & Profiles" section.
- Under the "Keys" section, click on the "+" button to create a new key. (make sure to select Apple Push Notifications service (APNs) from the checkbox)
- Make sure to write down the Key ID as you will need it later.
- Download the generated p8 file and save it to a secure location.
-
For pem file:
- Convert the exported .p12 file to a .pem file using the following command in the terminal:
Replace "Certificates.p12" with the path to your .p12 file or keep it if you're in the same directory as your .p12 file.openssl pkcs12 -clcerts -legacy -nodes -in Certificates.p12 -out AuthKey.pem
- Enter the password for the .p12 file when prompted (hit Enter if blank).
- The converted pem file will be saved as "AuthKey.pem" in the current directory.
- Convert the exported .p12 file to a .pem file using the following command in the terminal:
Once you have obtained the p8 or pem file, you can use it in the initialize_apns
function by providing the path to the file in the p8_key_path
or pem_file_path
parameter, respectively.
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
Built Distribution
File details
Details for the file aipkgs_notifications-1.0.2.tar.gz
.
File metadata
- Download URL: aipkgs_notifications-1.0.2.tar.gz
- Upload date:
- Size: 8.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.9.1 Darwin/23.5.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22790d339333de3abd1f0cd817dc2e17238c5f1c919c9480e4b35659dcfa3940 |
|
MD5 | 31e59e8c360d1bd75114a2ddf1df4778 |
|
BLAKE2b-256 | 5649fc7f66ef4a5755e2850dd366a7042e5e94f5322a7ed39e300d050db72f22 |
File details
Details for the file aipkgs_notifications-1.0.2-py3-none-any.whl
.
File metadata
- Download URL: aipkgs_notifications-1.0.2-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.9.1 Darwin/23.5.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 548c7760198f3fa5e62c57fde09cd27c09a6d23edd5089439ac37be797d25bec |
|
MD5 | 734bc1123ff742159c63ed29f0aefcb4 |
|
BLAKE2b-256 | b851804bf6af6c8e517884e72e817a242fa987d5f5a19e45c81aa7e57fd84460 |