apprise Documentation

Technical Documentation: caronc/apprise

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

ap·prise / verb
To inform or tell (someone). To make one aware of something.

Apprise allows you to send a notification to almost all of the most popular notification services available to us today such as: Telegram, Discord, Slack, Amazon SNS, Gotify, etc.

• One notification library to rule them all.
• A common and intuitive notification syntax.
• Supports the handling of images and attachments (to the notification services that will accept them).
• It's incredibly lightweight.
• Amazing response times because all messages sent asynchronously.

Developers who wish to provide a notification service no longer need to research each and every one out there. They no longer need to try to adapt to the new ones that comeout thereafter. They just need to include this one library and then they can immediately gain access to almost all of the notifications services available to us today.

System Administrators and DevOps who wish to send a notification now no longer need to find the right tool for the job. Everything is already wrapped and supported within the apprise command line tool (CLI) that ships with this product.

Visit the Official Documentation site for more information on Apprise.

How It Works

Apprise provides one consistent URL format and notification interface for your apps, automation, and infrastructure. Use the CLI or core library directly, or relay through Apprise API, to deliver notifications to a very large amount of supported services.

Table of Contents

• Supported Notifications
  • Productivity Based Notifications
  • SMS Notifications
  • Desktop Notifications
  • Email Notifications
  • Custom Notifications
• Installation
• Command Line Usage
  • Configuration Files
  • File Attachments
  • Loading Custom Notifications/Hooks
  • Environment Variables
• Developer API Usage
  • Configuration Files
  • File Attachments
  • Loading Custom Notifications/Hooks
• Persistent Storage
• More Supported Links and Documentation

Supported Notifications

The section identifies all of the services supported by this library. Check out the wiki for more information on the supported modules here.

Productivity Based Notifications Copy Chapter

The table below identifies the services this tool supports and some example service URLs you need to use in order to take advantage of it. Click on any of the services listed below to get more details on how you can configure Apprise to access them. If you're having trouble constructing your own URL; try our Apprise URL Builder out.

SMS Notifications Copy Chapter

SMS Notifications for the most part do not have a both a title and body. They consist of a single body which is usually no more then 160 characters in length. When using Apprise, the title and body are therefore combined into a single message prior to their transmission.

Desktop Notifications Copy Chapter

Email Notifications Copy Chapter

Apprise has some email services built right into it (such as yahoo, fastmail, hotmail, gmail, etc) that greatly simplify the mailto:// service. See more details here.

Custom Notifications Copy Chapter

Installation

The easiest way is to install Apprise from PyPI:

pip install apprise

If you use uv, you can install the apprise command in its own isolated environment, or add Apprise to your uv project:

# Install the apprise command
uv tool install apprise

# Or add it to your own project
uv add apprise

Apprise is also packaged as an RPM and available through EPEL supporting CentOS, Redhat, Rocky, Oracle Linux, etc.

# Follow instructions on https://docs.fedoraproject.org/en-US/epel
# to get your system connected up to EPEL and then:
# Redhat/CentOS 7.x users
yum install apprise

# Redhat/Rocky Linux 8.x+ and/or Fedora Users
dnf install apprise

You can also check out the Graphical version of Apprise to centralize your configuration and notifications through a manageable webpage.

Command Line Usage

A command line tool named apprise is included. Provide one or more service URLs to send a notification:

# Send to several services. The -vv option shows additional details.
apprise -vv -t 'my title' -b 'my notification body' \
   'mailto://myemail:[email protected]' \
   'pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b'

# If you don't specify a --body (-b) then stdin is used allowing
# you to use the tool as part of your every day administration:
cat /proc/cpuinfo | apprise -vv -t 'cpu info' \
   'mailto://myemail:[email protected]'

# The title field is totally optional
uptime | apprise -vv \
   'discord:///4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js'

CLI Configuration Files Copy Chapter

No one wants to put their credentials out for everyone to see on the command line. No problem, apprise also supports configuration files. It can handle both a specific YAML format or a very simple TEXT format. You can also pull these configuration files via an HTTP query too! Read more about the expected structure of the configuration files here.

/* Detailed source-code truncated for AI context efficiency. */

CLI Template Variables Copy Chapter

A YAML configuration can leave a value out of a URL and have it filled in
later, which lets you keep the configuration in version control without the
secrets in it.

Write ${NAME} where the value belongs and declare every name you use in a
template: section:

template:
  # A default is used unless the call supplies a value
  smtp_host: smtp.example.com
  # No default: the call or environment must fill this name
  api_key:

urls:
  - sendgrid://${API_KEY}:[email protected]/[email protected]:
      - tag: alerts

Apprise looks for each value in this order and stops at the first answer:

1. a value passed with --template-var (-tv)
2. the default written in the template: section
3. the environment variable APPRISE_TEMPLATE_<NAME>

The environment is the last resort, so it only ever fills in a name the
template: section declared without a default.

Values supplied for a call or through the environment are trimmed. If one is
blank afterwards, it reads as not supplied and the next source above applies.
A default written in the configuration stays as written. Use name: "" for an
explicit empty-string default; name: means the value is required.

# Supply it directly
apprise --config=apprise.yml --tag=alerts \
   --template-var api_key=your-secret-key \
   --body="Hello"

# Or leave it in the environment
export APPRISE_TEMPLATE_API_KEY=your-secret-key
apprise --config=apprise.yml --tag=alerts --body="Hello"

A service missing a required value is skipped while other services continue;
Apprise then exits with status 4. Use --dry-run to check required values
without sending anything.

Only names declared under template: are replaced. Names ignore case, values
keep their original case, and each value may be up to 1,024 characters.
Undeclared ${...} text remains unchanged, preventing similar text in an
existing password from being replaced by accident. Extra supplied names are
accepted and ignored.

Variables may be placed directly in a URL or in a named YAML setting. URL
markers can change any field, including the destination; whole-host markers
also accept user@host and user:pass@host. A named setting changes only its
option, so prefer it for values supplied by less-trusted callers.

Variables cannot replace the service before ://, a setting name, or a
tag:/tags: value. Services and tags must be known before values are filled
in. Template variables apply only to YAML configuration; TEXT configuration
is unchanged.

CLI Tagging Support Copy Chapter

Apprise allows you to tag your services in your configuration to organize them (e.g., family, devops, critical). You can then filter which services to notify using the --tag (-g) switch.

It is important to understand how Apprise handles multiple tags:

• OR Logic (Union): To notify services that have either Tag A OR Tag B, specify the -g switch multiple times.
• AND Logic (Intersection): To notify services that have both Tag A AND Tag B, separate the tags with a comma.

# OR Logic: Notify any service tagged 'devops' OR 'admin'
apprise -vv -t "Union Test" \
   --config=~/apprise.yml \
   -g devops -g admin

# AND Logic: Notify only services tagged with BOTH 'devops' AND 'critical'
apprise -vv -t "Intersection Test" \
   --config=~/apprise.yml \
   -g devops,critical

Tags also support an optional priority prefix and retry suffix. In your configuration file you assign a priority to a tag like 1:alerts or 5:alerts. A lower number means higher urgency.

• Escalation (no prefix): -g alerts dispatches priority-1 entries first. If they all succeed, Apprise returns early and never runs the priority-5 fallbacks. A failure in the lower-priority group triggers the next group as an escalation chain.
• Exclusive (with prefix): -g "2:alerts" notifies only services whose alerts tag has priority 2. No other priority levels are triggered.
• Per-call retry: -g "alerts:3" retries each matched service up to 3 times on failure (overrides the service's own retry setting for this call only).
• Combined: -g "2:alerts:3" selects only priority-2 services and allows up to 3 retries.

# Escalation: priority-1 first; skip priority-5 if all succeed
apprise -vv -t "Alert" --config=~/apprise.yml -g alerts

# Exclusive: only priority-2 alert services
apprise -vv -t "Alert" --config=~/apprise.yml -g "2:alerts"

# With retry override: retry each matched service up to 3 times
apprise -vv -t "Alert" --config=~/apprise.yml -g "alerts:3"

CLI File Attachments Copy Chapter

Apprise also supports file attachments too! Specify as many attachments to a notification as you want.

# Send a funny image you found on the internet to a colleague:
apprise -vv --title 'Agile Joke' \
        --body 'Did you see this one yet?' \
        --attach https://i.redd.it/my2t4d2fx0u31.jpg \
        'mailto://myemail:[email protected]'

# Easily send an update from a critical server to your dev team
apprise -vv --title 'system crash' \
        --body 'I do not think Jim fixed the bug; see attached...' \
        --attach /var/log/myprogram.log \
        --attach /var/debug/core.2345 \
        --tag devteam

CLI Loading Custom Notifications/Hooks Copy Chapter

To create your own custom schema:// hook so that you can trigger your own custom code,
simply include the @notify decorator to wrap your function.

from apprise.decorators import notify
#
# The below assumes you want to catch foobar:// calls:
#
@notify(on="foobar", name="My Custom Foobar Plugin")
def my_custom_notification_wrapper(body, title, notify_type, *args, **kwargs):
    """My custom notification function that triggers on all foobar:// calls
    """
    # Write all of your code here... as an example...
    print("{}: {} - {}".format(notify_type.upper(), title, body))

    # Returning True/False is a way to relay your status back to Apprise.
    # Returning nothing (None by default) is always interpreted as a Success

Once you've defined your custom hook, you just need to tell Apprise where it is at runtime.

# By default if no plugin path is specified apprise will attempt to load
# all plugin files (if present) from the following directory paths:
#  ~/.apprise/plugins
#  ~/.config/apprise/plugins
#  /var/lib/apprise/plugins

# Windows users can store their default plugin files in these directories:
#  %APPDATA%/Apprise/plugins
#  %LOCALAPPDATA%/Apprise/plugins
#  %ALLUSERSPROFILE%\Apprise\plugins
#  %PROGRAMFILES%\Apprise\plugins
#  %COMMONPROGRAMFILES%\Apprise\plugins

# If you placed your plugin file within one of the directories already defined
# above, then your call simply needs to look like:
apprise -vv --title 'custom override' \
        --body 'the body of my message' \
        foobar:\\

# However you can override the path like so
apprise -vv --title 'custom override' \
        --body 'the body of my message' \
        --plugin-path /path/to/my/plugin.py \
        foobar:\\

You can read more about creating your own custom notifications and/or hooks here.

CLI Environment Variables Copy Chapter

Those using the Command Line Interface (CLI) can also leverage environment variables to pre-set the default settings:

Developer API Usage

To send a notification from within your python application, just do the following:

import apprise

# Create an Apprise instance
apobj = apprise.Apprise()

# Add notification services by URL.
# A sample email notification:
apobj.add('mailto://myuserid:[email protected]')

# A sample pushbullet notification
apobj.add('pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b')

# Then notify these services any time you desire. The below would
# notify all of the services loaded into our Apprise object.
apobj.notify(
    body='what a great notification service!',
    title='my notification title',
)

API Configuration Files Copy Chapter

Developers need access to configuration files too. The good news is that their use just involves declaring another object (called AppriseConfig) that the Apprise object can ingest. You can also freely mix and match config and notification entries as often as you wish! You can read more about the expected structure of the configuration files here.

import apprise

# Create an Apprise instance
apobj = apprise.Apprise()

# Create an Config instance
config = apprise.AppriseConfig()

# Add a configuration source:
config.add('/path/to/my/config.yml')

# Add another...
config.add('https://myserver:8080/path/to/config')

# Make sure to add our config into our apprise object
apobj.add(config)

# You can mix and match; add an entry directly if you want too
# In this entry we associate the 'admin' tag with our notification
apobj.add('mailto://myuser:[email protected]', tag='admin')

# Then notify these services any time you desire. The below would
# notify all of the services that have not been bound to any specific
# tag.
apobj.notify(
    body='what a great notification service!',
    title='my notification title',
)

# Tagging allows you to specifically target only specific notification
# services you've loaded:
apobj.notify(
    body='send a notification to our admin group',
    title='Attention Admins',
    # notify any services tagged with the 'admin' tag
    tag='admin',
)

# If you want to notify absolutely everything (regardless of whether
# it's been tagged or not), just use the reserved tag of 'all':
apobj.notify(
    body='send a notification to our admin group',
    title='Attention Admins',
    # notify absolutely everything loaded, regardless on whether
    # it has a tag associated with it or not:
    tag='all',
)

API Template Variables Copy Chapter

After loading a templated YAML configuration, developers can supply its values
when sending:

apobj.notify(
    body='what a great notification service!',
    title='my notification title',
    template={'api_key': 'your-secret-key'},
)

The per-call mapping takes priority over APPRISE_TEMPLATE_<NAME> environment
variables and defaults in the YAML file. Names are case-insensitive, and extra
names are accepted and ignored.

Templates are enabled by default. To turn them off, use the same disabled asset
for the configuration and its Apprise object:

asset = apprise.AppriseAsset(allow_templates=False)
config = apprise.AppriseConfig(asset=asset)
apobj = apprise.Apprise(asset=asset)
apobj.add(config)

When disabled, the template: section and template environment variables are
ignored, and ${NAME} remains unchanged. A configuration cannot enable this
feature itself.

API File Attachments Copy Chapter

Attachments are very easy to send using the Apprise API:

import apprise

# Create an Apprise instance
apobj = apprise.Apprise()

# Add at least one service you want to notify
apobj.add('mailto://myuser:[email protected]')

# Then send your attachment.
apobj.notify(
    title='A great photo of our family',
    body='The flash caused Jane to close her eyes! hah! :)',
    attach='/local/path/to/my/DSC_003.jpg',
)

# Send a web based attachment too! In the below example, we connect to a home
# security camera and send a live image to an email. By default remote web
# content is cached, but for a security camera we might want to call notify
# again later in our code, so we want our last image retrieved to expire(in
# this case after 3 seconds).
apobj.notify(
    title='Latest security image',
    attach='http://admin:password@hikvision-cam01/ISAPI/Streaming/channels/101/picture?cache=3'
)

To send more than one attachment, just use a list, set, or tuple instead:

import apprise

# Create an Apprise instance
apobj = apprise.Apprise()

# Add at least one service you want to notify
apobj.add('mailto://myuser:[email protected]')

# Now add all of the entries we're interested in:
attach = (
    # ?name= allows us to rename the actual jpeg as found on the site
    # to be another name when sent to our receipient(s)
    'https://i.redd.it/my2t4d2fx0u31.jpg?name=FlyingToMars.jpg',

    # Now add another:
    '/path/to/funny/joke.gif',
)

# Send your multiple attachments with a single notify call:
apobj.notify(
    title='Some good jokes.',
    body='Hey guys, check out these!',
    attach=attach,
)

API Loading Custom Notifications/Hooks Copy Chapter

By default, no custom plugins are loaded at all for those building from within the Apprise API.
It's at the developers discretion to load custom modules. But should you choose to do so, it's as easy
as including the path reference in the AppriseAsset() object prior to the initialization of your Apprise()
instance.

For example:

from apprise import Apprise
from apprise import AppriseAsset

# Prepare your Asset object so that you can enable the custom plugins to
# be loaded for your instance of Apprise...
asset = AppriseAsset(plugin_paths="/path/to/scan")

# OR You can also generate scan more then one file too:
asset = AppriseAsset(
    plugin_paths=[
        # Iterate over all python libraries found in the root of the
        # specified path. This is NOT a recursive (directory) scan; only
        # the first level is parsed. HOWEVER, if a directory containing
        # an __init__.py is found, it will be included in the load.
        "/dir/containing/many/python/libraries",

        # An absolute path to a plugin.py to exclusively load
        "/path/to/plugin.py",

        # if you point to a directory that has an __init__.py file found in
        # it, then only that file is loaded (it's similar to point to a
        # absolute .py file. Hence, there is no (level 1) scanning at all
        # within the directory specified.
        "/path/to/dir/library"
    ]
)

# Now that we've got our asset, we just work with our Apprise object as we
# normally do
aobj = Apprise(asset=asset)

# If our new custom `foobar://` library was loaded (presuming we prepared
# one like in the examples above).  then you would be able to safely add it
# into Apprise at this point
aobj.add('foobar://')

# Send our notification out through our foobar://
aobj.notify("test")

You can read more about creating your own custom notifications and/or hooks here.

Persistent Storage

Persistent storage allows Apprise to cache re-occurring actions optionaly to disk. This can greatly reduce the overhead used to send a notification.

There are 3 Persistent Storage operational states Apprise can operate using:

1. auto: Flush gathered cache information to the filesystem on demand. This option is incredibly light weight. This is the default behavior for all CLI usage.
   • Developers who choose to use this operational mode can also force cached information manually if they choose.
   • The CLI will use this operational mode by default.
2. flush: Flushes any cache information to the filesystem during every transaction.
3. memory: Effectively disable Persistent Storage. Any caching of data required by each plugin used is done in memory. Apprise effectively operates as it always did before peristent storage was available. This setting ensures no content is ever written to disk.
   • By default this is the mode Apprise will operate under for those developing with it unless they configure it to otherwise operate as auto or flush. This is done through the AppriseAsset() object and is explained further on in this documentation.

CLI Persistent Storage Commands Copy Chapter

You can provide the keyword storage on your CLI call to see the persistent storage options available to you.

# List all of the occupied space used by Apprise's Persistent Storage:
apprise storage list

# list is the default option, so the following does the same thing:
apprise storage

# You can prune all of your storage older then 30 days
# and not accessed for this period like so:
apprise storage prune

# You can do a hard reset (and wipe all persistent storage) with:
apprise storage clean

You can also filter your results by adding tags and/or URL Identifiers. When you get a listing (apprise storage list), you may see:

# example output of 'apprise storage list':
   1. f7077a65                                             0.00B    unused
      - matrixs://abcdef:****@synapse.example12.com/%23general?image=no&mode=off&version=3&msgtype...
      tags: team

   2. 0e873a46                                            81.10B    active
      - tgram://W...U//?image=False&detect=yes&silent=no&preview=no&content=before&mdv=v1&format=m...
      tags: personal

   3. abcd123                                             12.00B    stale

The (persistent storage) cache states are:

• unused: This plugin has not commited anything to disk for reuse/cache purposes
• active: This plugin has written content to disk. Or at the very least, it has prepared a persistent storage location it can write into.
• stale: The system detected a location where a URL may have possibly written to in the past, but there is nothing linking to it using the URLs provided. It is likely wasting space or is no longer of any use.

You can use this information to filter your results by specifying URL ID (UID) values after your command. For example:

# The below commands continue with the example already identified above
# the following would match abcd123 (even though just ab was provided)
# The output would only list the 'stale' entry above
apprise storage list ab

# knowing our filter is safe, we could remove it
# the below command would not obstruct our other to URLs and would only
# remove our stale one:
apprise storage clean ab

# Entries can be filtered by tag as well:
apprise storage list --tag=team

# You can match on multiple URL ID's as well:
# The followin would actually match the URL ID's of 1. and .2 above
apprise storage list f 0

When using the CLI, Persistent storage is set to the operational mode of auto by default, you can change this by providing --storage-mode= (-SM) during your calls. If you want to ensure it's always set to a value of your choice.

For more information on persistent storage, visit here.

API Persistent Storage Commands Copy Chapter

For developers, persistent storage is set in the operational mode of memory by default.

It's at the developers discretion to enable it (by switching it to either auto or flush). Should you choose to do so: it's as easy as including the information in the AppriseAsset() object prior to the initialization of your Apprise() instance.

For example:

from apprise import Apprise
from apprise import AppriseAsset
from apprise import PersistentStoreMode

# Prepare a location the persistent storage can write it's cached content to.
# By setting this path, this immediately assumes you wish to operate the
# persistent storage in the operational 'auto' mode
asset = AppriseAsset(storage_path="/path/to/save/data")

# If you want to be more explicit and set more options, then you may do the
# following
asset = AppriseAsset(
    # Set our storage path directory (minimum requirement to enable it)
    storage_path="/path/to/save/data",

    # Set the mode... the options are:
    # 1. PersistentStoreMode.MEMORY
    #       - disable persistent storage from writing to disk
    # 2. PersistentStoreMode.AUTO
    #       - write to disk on demand
    # 3. PersistentStoreMode.FLUSH
    #       - write to disk always and often
    storage_mode=PersistentStoreMode.FLUSH

    # The URL IDs are by default 8 characters in length. You can increase and
    # decrease it's value here.  The value must be > 2. The default value is 8
    # if not otherwise specified
    storage_idlen=8,
)

# Now that we've got our asset, we just work with our Apprise object as we
# normally do
aobj = Apprise(asset=asset)

For more information on persistent storage, visit here.

Want To Learn More?

If you're interested in reading more about this and other methods on how to customize your own notifications, please check out the following links:

• 📣 Using the CLI
• 🛠️ Development API
• ⚙️ Configuration File Help
• ⚡ Create Your Own Custom Notifications
• 🌎 Apprise API/Web Interface
• 📖 Apprise Documentation Source
• 🔧 Troubleshooting
• 🎉 Showcase

Want to help make Apprise better?

• 💡 Contribute to the Apprise Code Base
• ❤️ Sponsorship and Donations

Overview (`bin/README.md`) Copy Section

🛠️ Apprise Development Guide

Welcome! This guide helps you contribute to Apprise with confidence. It outlines
how to set up your local environment, run tests, lint your code, and build
packages — all using modern tools like Tox and
Ruff.

🚀 Getting Started Copy Chapter

Set up your local development environment using Tox:

# Install Tox
python -m pip install tox

Tox manages dependencies, linting, testing, and builds — no need to manually
install requirements-dev.txt.

🧪 Running Tests Copy Chapter

Use the qa environment for full testing and plugin coverage:

tox -e qa

To focus on specific tests (e.g., email-related):

tox -e qa -- -k email

To run a minimal dependency test set:

tox -e minimal

🧹 Linting and Formatting Copy Chapter

Apprise uses Ruff for linting and formatting.
This is configured via pyproject.toml.

Run linting:

tox -e lint

Fix formatting automatically (where possible):

tox -e format

Linting runs automatically on all PRs that touch Python files via GitHub
Actions and will fail builds on violation.

✅ Pre-Commit Check (Recommended) Copy Chapter

Before pushing or creating a PR, validate your work with:

tox -e lint,qa

Or use a combined check shortcut (if defined):

tox -e checkdone

This ensures your changes are linted, tested, and PR-ready.

📨 CLI Testing Copy Chapter

You can run the apprise CLI using your local code without installation or run within docker containers:

# From the root of the repo
./bin/apprise -t "Title" -b "Body" mailto://user:[email protected]

Alternatively you can continue to use the tox environment:

# syntax tox -e apprise -- [options], e.g.:
tox -e apprise -- -vv -b "test body" -t "test title" mailto://credentials

Optionally, add the bin/apprise to tests your changes

bin/apprise -vv -b "test body" -t "test title" <schema>

📦 RPM Build & Verification Copy Chapter

Apprise supports RPM packaging for Fedora and RHEL-based systems. Use Docker
to safely test builds:

# Build RPM for EL9
docker-compose run --rm rpmbuild.el9 /apprise/bin/build-rpm.sh

# Build RPM for EL10
docker-compose run --rm rpmbuild.el10 /apprise/bin/build-rpm.sh

# Build RPM for Fedora 44
docker-compose run --rm rpmbuild.f44 /apprise/bin/build-rpm.sh

📦 Specific Environment Emulation Copy Chapter

You can also emulate your own docker environment and just test/build inside that

# Python v3.9 Testing
docker-compose run --rm test.py39 bash

# Python v3.10 Testing
docker-compose run --rm test.py310 bash

# Python v3.11 Testing
docker-compose run --rm test.py311 bash

# Python v3.12 Testing
docker-compose run --rm test.py312 bash

Once you've entered one of these environments, you can leverage the following command to work with:

1. bin/test.sh: runs the full test suite (same as tox -e qa) but without coveage
2. bin/checkdone.sh: runs the full test suite (same as tox -e qa)
3. bin/apprise: launches the Apprise CLI using the local build (same as tox -e apprise)
4. ruff check . --fix: auto-formats the codebase (same as tox -e format)
5. ruff check .: performs lint-only validation (same as tox -e lint)
6. pytest tests -n auto --maxprocesses=8 --cov=apprise: runs coverage tests across up to 8 CPU cores

The only advantage of this route is the overhead associated with each tox call is gone (faster responses). Otherwise just utilizing the tox commands can sometimes be easier.

🧪 GitHub Actions Copy Chapter

GitHub Actions runs:

• ✅ Full test suite with coverage
• ✅ Linting (using Ruff)
• ✅ Packaging and validation

Linting must pass before PRs can be merged.

🧠 Developer Tips Copy Chapter

• Add new plugins by following the samples in the Plugin guide.
• Multi-target plugins must record each success with mark_delivered() so
  retries do not notify the same target twice.
• Write unit tests under tests/ using the AppriseURLTester pattern.
• All new plugins must include test coverage and pass linting.

Overview (`packaging/README.md`) Copy Section

Packaging Copy Chapter

This directory contains any supporting files to grant usage of Apprise in various distributions.

Let me know if you'd like to help me host on more platforms or can offer to do it yourself!

RPM Based Packages Copy Section

• EPEL based distributions are only supported if they are of v9 or higher. This includes:
  • Red Hat 10.x (or higher)
  • Scientific OS 10.x (or higher)
  • Oracle Linux 10.x (or higher)
  • Rocky Linux 10.x (or higher)
  • Alma Linux 110.x (or higher)
  • Fedora 29 (or higher)

Provided you are connected to the EPEL repositories, the following will just work for you:

# python3-apprise: contains all you need to develop with apprise
# apprise: provides the 'apprise' administrative tool
dnf install python3-apprise apprise

You can build your own rpm packges with the following:

• EPEL10 (Rocky/RedHat/Oracle Linux)

  bash Copy

  tox -e build-el10-rpm

• EPEL9 (Rocky/RedHat/Oracle Linux)

  bash Copy

  tox -e build-el9-rpm

• Fedora 44

  bash Copy

  tox -e build-f44-rpm

• Fedora Rawhide

  bash Copy

  tox -e build-rawhide-rpm

Man Pages Information Copy Chapter

The man page were generated using Ronn.

• Content is directly written to entries in the man/*.md files following the
  the format structure available on the Ronn site.
• Then the following is executed ronn --roff man/apprise.md to produce the man/apprise.1 which is used by distributions.

The easiest way to generate the new man page (after updating the .md file is:

# rebuild man page
tox -e man

--- METRICS ---

• Files Extracted: 3
• Estimated Token Budget: ~17207 tokens
• Canonical Reference: https://codewiki.google/github.com/caronc/apprise