{"name":"Apprise: Universal Push Notifications for Nearly Every Platform","description":"Apprise is a powerful Python library and command-line tool designed to simplify sending push notifications across a vast array of services. It offers a unified API and intuitive syntax, allowing developers and system administrators to integrate notifications with ease. Supporting almost every popular notification platform, Apprise streamlines communication and alerts for various applications.","github":"https://github.com/caronc/apprise","url":"https://osrepos.com/repo/caronc-apprise","source":"osrepos.com","sourceDescription":"This repository profile is provided by osrepos.com, an open source repository discovery platform.","repositoryProfile":"https://osrepos.com/repo/caronc-apprise","generatedFor":"open source discovery and AI-assisted research","markdown":"https://osrepos.com/repo/caronc-apprise.md","json":"https://osrepos.com/repo/caronc-apprise.json","topics":["apprise","notifications","push-notifications","python","devops","alerts","automation","notification-service"],"keywords":["apprise","notifications","push-notifications","python","devops","alerts","automation","notification-service"],"stars":null,"summary":"Apprise is a powerful Python library and command-line tool designed to simplify sending push notifications across a vast array of services. It offers a unified API and intuitive syntax, allowing developers and system administrators to integrate notifications with ease. Supporting almost every popular notification platform, Apprise streamlines communication and alerts for various applications.","content":"## Introduction\nApprise is an incredibly versatile Python library and command-line tool that simplifies sending push notifications to almost every popular notification service available today. With over 14,600 stars and 500 forks on GitHub, Apprise has become a go-to solution for developers and system administrators seeking a unified approach to alerts and communication. It eliminates the need to learn individual APIs for services like Telegram, Discord, Slack, Amazon SNS, Gotify, and many more, providing a common and intuitive syntax for all.\n\n## Installation\nGetting started with Apprise is straightforward. The easiest method is to install it via PyPI:\n\nbash\npip install apprise\n\n\nFor users on Redhat, CentOS, Rocky, Oracle Linux, and Fedora, Apprise is also available through EPEL:\n\nbash\n# Follow instructions on https://docs.fedoraproject.org/en-US/epel\n# to get your system connected up to EPEL and then:\n# Redhat/CentOS 7.x users\nyum install apprise\n\n# Redhat/CentOS 8.x+ and/or Fedora Users\ndnf install apprise\n\n\nIf you prefer a graphical interface, consider the [Apprise API/Web Interface](https://github.com/caronc/apprise-api) for centralized configuration and notification management.\n\n## Examples\nApprise offers both a powerful command-line interface (CLI) and a flexible Python API.\n\n### Command Line Interface (CLI)\n\nSend notifications directly from your terminal:\n\nbash\n# Send a notification to multiple services\napprise -vv -t 'My Server Alert' -b 'Disk space is low on /dev/sda1!' \\\n   'mailto://myemail:mypass@gmail.com' \\\n   'pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b'\n\n# Use stdin for the body\ncat /var/log/syslog | apprise -vv -t 'Latest Syslog Entries' \\\n   'discord:///webhook_id/webhook_token'\n\n\nApprise also supports configuration files (YAML or plain text) to store your notification URLs securely, avoiding credentials on the command line.\n\nbash\n# Example using a configuration file\napprise -vv -t 'Daily Report' -b 'See attached for today\\'s summary.' \\\n   --config=/path/to/my/config.yml \\\n   --attach=/var/reports/daily.pdf\n\n\n### Python API\n\nIntegrate Apprise into your Python applications with ease:\n\npython\nimport apprise\n\n# Create an Apprise instance\napobj = apprise.Apprise()\n\n# Add notification services\napobj.add('mailto://myuserid:mypass@gmail.com')\napobj.add('tgram://bottoken/ChatID')\n\n# Send a notification\napobj.notify(\n    body='Your task has completed successfully!',\n    title='Process Complete',\n)\n\n# Use configuration files with the API\nfrom apprise import AppriseConfig\n\nconfig = apprise.AppriseConfig()\nconfig.add('https://myserver:8080/path/to/config')\napobj.add(config)\n\n# Send to specific tagged services\napobj.add('slack://TokenA/TokenB/TokenC/Channel', tag='devteam')\napobj.notify(\n    body='Critical error in production!',\n    title='Urgent: Production Issue',\n    tag='devteam',\n)\n\n\n## Why Use Apprise\nApprise stands out as a comprehensive notification solution due to several key advantages:\n\n*   **Unmatched Versatility:** It supports an extensive list of notification services, including popular chat platforms, email providers, SMS gateways, desktop notifications, and even custom webhooks (JSON, XML, Form). This \"one library to rule them all\" approach drastically reduces integration complexity.\n*   **Simplified Integration:** With a consistent API and CLI, developers and system administrators can quickly add notification capabilities without needing to learn the specifics of each service.\n*   **Asynchronous Performance:** All messages are sent asynchronously, ensuring amazing response times and minimal impact on your application's performance.\n*   **Flexible Configuration:** Support for configuration files, environment variables, and tagging allows for secure and organized management of notification endpoints, making it easy to target specific groups or services.\n*   **Rich Features:** Beyond basic messages, Apprise handles images and file attachments, offers persistent storage for caching, and allows for the creation of custom notification hooks.\n\n## Links\nFor more detailed information and to explore Apprise further, please visit the official resources:\n\n*   [GitHub Repository](https://github.com/caronc/apprise)\n*   [CLI Usage Wiki](https://github.com/caronc/apprise/wiki/CLI_Usage)\n*   [Development API Wiki](https://github.com/caronc/apprise/wiki/Development_API)\n*   [Configuration File Help Wiki](https://github.com/caronc/apprise/wiki/config)\n*   [Create Your Own Custom Notifications Wiki](https://github.com/caronc/apprise/wiki/decorator_notify)\n*   [Persistent Storage Wiki](https://github.com/caronc/apprise/wiki/persistent_storage)\n*   [Apprise API/Web Interface](https://github.com/caronc/apprise-api)\n*   [Showcase](https://github.com/caronc/apprise/wiki/showcase)\n*   [Contribution Guidelines](https://github.com/caronc/apprise/wiki/Development_Contribution)\n*   [Sponsorship and Donations](https://github.com/caronc/apprise/wiki/Sponsors)","metrics":{"detailViews":5,"githubClicks":10},"dates":{"published":null,"modified":"2025-10-12T03:20:29.000Z"}}