Sourced from apprise's releases.
Apprise v2.0.0
What's Changed
:tada: Welcome to Apprise v2.0.0! :tada:
This is the first official release of Apprise v2. It's a big one. Much of how Apprise works under the hood was rebuilt, and many features people have asked for over the years are finally here:
- template variables to keep secrets out of your config files
- tag priorities and escalation
- smarter retries
- timeouts
- a detailed
AppriseResultobject returned from everynotify()call- ...and much more
Note: :warning: This is a breaking release for anyone using Apprise v1.x. If you are a developer embedding Apprise in your own project, please read the Breaking Changes section below before upgrading. If you are not ready to move yet, pin your
pyproject.tomlorrequirements.txttoapprise >=1.0.0, <2.0.0. The v1 codebase lives on in theapprise-v1-releasebranch. I will keep patching it for security issues and bugs where practical for a year or two, but v2.x is the way forward.:warning: Breaking Changes
notify()now returns anAppriseResultobject instead ofTrue/False/None
bool(result)still gives youTrue/False, so most existingif apobj.notify(...):checks keep working.Nonecan't come back frombool(), so a "nothing matched" result now reads asFalse.- The object also holds the logs for each individual service called, plus a status for each one, so your application can report exactly what worked and what didn't.
- The status values line up with the CLI exit codes:
SUCCESS(0) - every service was notified successfully (the oldTrue)FAILURE(1) - the notification failed (the oldFalse)NOMATCH(3) - nothing matched the tags given, or no services were loaded (the oldNone)PARTIAL(4) - some services succeeded but at least one failed (v1 returnedFalsehere)TIMEOUT(5) - a service didn't finish before its time limit (new in v2)- Multiple body formats per service
- In v1 each service supported a single body format. Services can now support more than one when the upstream service allows it (Telegram, for example, accepts both Markdown and HTML).
- Apprise picks the best matching format automatically based on the
formatyou send with, so it no longer rewrites your content when the service can already accept it as-is.- You can also choose the format yourself in the URL with
?format=.- Consistent error handling
- Every error Apprise raises now comes from a single
AppriseExceptionfamily, so developers can catch everything in one place.- Each error still behaves like the plain Python error it used to be (a bad setting is still a
ValueError, a disk problem is still anOSError), so existingtry/exceptblocks keep working.- Deprecations removed - Apprise v2 starts with a clean slate:
- The
APPRISE_CONFIGenvironment variable is nowAPPRISE_CONFIG_PATH. The old name still works for now, but prints a deprecation warning.- The Email options
use_pgp=and?pgpkey=(deprecated back in v1) have been removed. Usepgp_mode=and?pgppub=instead.- Bad settings in a URL (such as an unknown
?format=) now fail with a clear error message instead of quietly doing something unexpected.:mega: New Notification Services:
- Delta Chat (
deltachat://) support added in caronc/apprise#1666- WPUSH (
wpush://) support added by@anhaoin caronc/apprise#1721- YouLMK (
youlmk://) support added by@elilatin caronc/apprise#1726- Telnyx SMS (
telnyx://) support added by@anandghegdein caronc/apprise#1731:lady_beetle: Bugfixes
- DingTalk Markdown messages now set
msgtypetomarkdownso they actually get delivered by@xtqxkin caronc/apprise#1733- OneSignal now honors
language=and keeps it inurl()by@MaxFreedomPollardin caronc/apprise#1720- SIGNL4 now keeps its query parameters in
url()by@MaxFreedomPollardin caronc/apprise#1732- VAPID now delivers to the subscription endpoint instead of a per-mode base URL by
@RT530in caronc/apprise#1728- Fluxer now works with self-hosted servers by using the correct URL by
@LaaZain caronc/apprise#1740- ntfy
attach=filename detection fixed, andfilename=is kept inurl()by@SulimanAbdulrazzaqin caronc/apprise#1744- Compressed IPv6 addresses are now handled properly in caronc/apprise#1734
... (truncated)
68f0eaf
bumped version to v2.0.0782f303
Fixed o365:// inline attachment contentType sent as a literal string (#1747)a5b7e51
Keep CC display names in url() for mailgun, ses, smtp2go and sparkpost
(#1749)5c4f272
Apprise v2 Release (#1666)971861b
handling of Apprise v1 Branch6819cc4
reduced codecov retention of file in github from 90 days to 71fe1f70
Fix ntfy:// attach= filename detection and keep filename= in url() (#1744)2e72688
fixes issue with yaml/config parsing (#1743)a02d47b
Fluxer improvements to self-hosted api path (#1740)9e15330
Additional improvements/handling of macosx terminal-notifier wrapper (#1742)