Skip to content

Apprise Python (Core) Library

The Apprise library allows you to send notifications to almost all of the most popular notification services available today (Telegram, Discord, Slack, Email, etc.) using a single, unified Python API.

The library is the engine underneath everything else: the CLI, the API server, and the mobile app all send through it.

The Apprise core library highlighted among the ways to send notifications through Apprise.

For common helpers used across plugins, see the Utilities Reference.

Apprise is available on PyPI and can be installed via pip.

Terminal window
pip install apprise

If your project uses uv:

Terminal window
uv add apprise

The core of the library is the Apprise object. You instantiate it, add URLs, and trigger notifications.

import apprise
# 1. Instantiate the Apprise Object
apobj = apprise.Apprise()
# 2. Add one or more service URLs
apobj.add('mailto://myuser:mypass@hotmail.com')
apobj.add('tgram://123456789:ABCDefghIJKLmnOPqrstUVwxyz')
# 3. Send a notification to all added services
apobj.notify(
body='What a great notification service!',
title='My Notification Title',
)
Questions or Feedback?

Documentation

Notice a typo or an error?

Technical Issues

Having trouble with the code? Open an issue on GitHub:

Made with love from Canada