Hello World!
# For django templating engine {% webpush_button %} # For jinja templating engine {{ webpush_button() }} ``` Or if you want to add custom classes (e.g. bootstrap) ```htmlHello World!
# For django templating engine {% webpush_button with_class="btn btn-outline-info" %} # For jinja templating engine {{ webpush_button(with_class="btn btn-outline-info") }} ``` >**Note:** The Push Notification Button will show only if the user is logged in or any `group` named is passed through `webpush` context ***If you would like to mark the subscription as a group, like all person subscribe for push notification from the template should be marked as group and would get same notification, you should pass a `webpush` context to the template through views. The `webpush` context should have a dictionary like `{"group": group_name}`*** . Like following ```python webpush = {"group": group_name } # The group_name should be the name you would define. return render(request, 'template.html', {"webpush":webpush}) ``` > **Note:** If you dont pass `group` through the `webpush` context, only logged in users can see the button for subscription and able to get notification. ---------- Sending Web Push Notification ----------------------------- A Web Push generally have a header and body. According to the W3C Specification, the data should be encrypted in transmission. The data is addressed as payload generally. Also a TTL header should be included indicating how much time the web push server store the data if the user is not online. So in order to send notification, see below. - If you would like to send notification to a specific group, do like following: ```python from webpush import send_group_notification payload = {"head": "Welcome!", "body": "Hello World"} send_group_notification(group_name="my_group", payload=payload, ttl=1000) # All subscribe subscribe through "my_group" will get a web push notification. # A ttl of 1000 is passed so the web push server will store # the data maximum 1000 seconds if any user is not online ``` - If you would like to send Notification to a specific user, do like following ```python from webpush import send_user_notification payload = {"head": "Welcome!", "body": "Hello World"} send_user_notification(user=user, payload=payload, ttl=1000) # Here in the user parameter, a user object should be passed # The user will get notification to all of his subscribed browser. A user can subscribe many browsers. ``` **And the subscribers will get a notification like:**  - If you notification should have an icon or open a url when clicked, you can add those to the payload: ``` python from webpush import send_user_notification from webpush import send_group_notification payload = {"head": "Welcome!", "body”: "Hello World", "icon": "https://i.imgur.com/dRDxiCQ.png“, "url": "https://www.example.com"} send_group_notification(group_name="my_group", payload=payload, ttl=1000) ``` **And the subscribers will get a notification like:**  **That will open https://www.example.com if clicked.** - If you want fine grained control over sending a single push message, do like following ```python from webpush.utils import send_to_subscription payload = {"head": "Welcome!", "body": "Hello World"} user = request.user push_infos = user.webpush_info.select_related("subscription") for push_info in push_infos: send_to_subscription(push_info.subscription, payload) ``` **And the subscribers will get a notification like**  Contributing ------------ If you would like to contribute, fork the repository and send a pull request. You can also open an issue if you find any bug or want to suggest a feature. Internationalization --------------------- The package is shipped with built in internationalization support. If you would like to add more language or update translation, you can run the following command: ```bash # Add js translation django-admin makemessages -d djangojs -l