This project aims to provide a wrapper for the Novu API.
Project description
Python Novu SDK
The Python Novu SDK and package provides a fluent and expressive interface for interacting with Novu's API and managing notifications.
Install
To install this package
# Via pip
pip install novu
# Via poetry
poetry add novu
Quick start
This package is a wrapper of all the resources offered by Novu, we will just start by triggering an event on Novu.
To do this, you will need to:
- Create your first notification template and keep in mind the identifier to trigger the template: https://docs.novu.co/overview/quick-start#create-a-notification-template
- Retrieve your API key from the Novu dashboard directly in the settings section: https://web.novu.co/settings
- Write code to trigger your first event:
from novu.api import EventApi
event_api = EventApi("https://api.novu.co/api/", "<NOVU_API_TOKEN>")
event_api.trigger(
name="<YOUR_TEMPLATE_NAME>",
recipients="<YOUR_SUBSCRIBER_ID>",
payload={}, # Your Novu payload goes here
)
This will trigger a notification to the subscribers.
Development
# install deps
poetry install
# pre-commit
poetry run pre-commit install --install-hook
poetry run pre-commit install --install-hooks --hook-type commit-msg
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
novu-1.3.0.tar.gz
(26.2 kB
view hashes)
Built Distribution
novu-1.3.0-py3-none-any.whl
(43.4 kB
view hashes)