Skip to content

Apprise

Apprise is a notification library that offers a unified way to send notifications across various platforms. It supports multiple notification services and simplifies the process of integrating notifications into your applications.

Apprise supports various notification services including:

  • Email
  • SMS
  • Push notifications
  • Webhooks
  • And more

Each service requires specific configurations, such as API keys or server URLs.

Installation⚑

To use Apprise, you need to install the package via pip:

pip install apprise

Usage⚑

Configuration⚑

Apprise supports a range of notification services. You can configure notifications by adding service URLs with the appropriate credentials and settings.

For example, to set up email notifications, you can configure it like this:

import apprise

# Initialize Apprise
apobj = apprise.Apprise()

# Add email notification service
apobj.add("mailto://user:password@smtp.example.com:587/")

# Send the notification
apobj.notify(
    body="This is a test message.",
    title="Test notification",
)

Sending notifications⚑

To send a notification, use the notify method. This method accepts parameters such as body for the message content and title for the notification title.

Example:

apobj.notify(
    body="Here is the message content.",
    title="Notification title",
)

References⚑