instruction stringclasses 100
values | code stringlengths 78 193k | response stringlengths 259 170k | file stringlengths 59 203 |
|---|---|---|---|
Generate docstrings for script automation | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -25,6 +25,12 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""Jellyfin Notification Plugin.
+
+Jellyfin is a fork of Emby and kept compatible endpoints for the on-screen
+message / remote control features used by Apprise.
+
+"""
from __fu... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/jellyfin.py |
Add well-formatted docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -35,6 +35,7 @@
class AttachFile(AttachBase):
+ """A wrapper for File based attachment sources."""
# The default descriptive name associated with the service
service_name = _("Local File")
@@ -47,6 +48,7 @@ location = ContentLocation.LOCAL
def __init__(self, path, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/attachment/file.py |
Add detailed documentation for each class | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -25,6 +25,7 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""A minimal IRC client for notification delivery."""
from __future__ import annotations
@@ -50,6 +51,7 @@
class IRCClient:
+ """Socket-driven IRC Client."""
# IRC ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/irc/client.py |
Write docstrings for utility functions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -24,6 +24,14 @@ # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""
+46elks SMS Notification Service.
+
+Minimal URL formats (source ends up being target):
+ - 46elks://use... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/fortysixelks.py |
Document this script properly | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -85,6 +85,7 @@
class NotifyGrowl(NotifyBase):
+ """A wrapper to Growl Notifications."""
# Set our global enabled flag
enabled = NOTIFY_GROWL_SUPPORT_ENABLED
@@ -193,6 +194,7 @@ sticky=False,
**kwargs,
):
+ """Initialize Growl Object."""
super().__init_... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/growl.py |
Add concise docstrings to each method | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -60,6 +60,7 @@
class NotifyFlock(NotifyBase):
+ """A wrapper for Flock Notifications."""
# The default descriptive name associated with the Notification
service_name = "Flock"
@@ -144,6 +145,7 @@ )
def __init__(self, token, targets=None, include_image=True, **kwargs):
+ "... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/flock.py |
Create documentation for each function signature | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -39,6 +39,7 @@
class NotifyHttpSMS(NotifyBase):
+ """A wrapper for HttpSMS Notifications."""
# The default descriptive name associated with the Notification
service_name = "httpSMS"
@@ -120,6 +121,7 @@ )
def __init__(self, apikey=None, source=None, targets=None, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/httpsms.py |
Add docstrings following best practices | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -41,6 +41,7 @@
class NotifyHomeAssistant(NotifyBase):
+ """A wrapper for Home Assistant Notifications."""
# The default descriptive name associated with the Notification
service_name = "HomeAssistant"
@@ -117,6 +118,7 @@ )
def __init__(self, accesstoken, nid=None, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/home_assistant.py |
Add docstrings including usage examples | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -53,6 +53,7 @@
class NotifyKumulos(NotifyBase):
+ """A wrapper for Kumulos Notifications."""
# The default descriptive name associated with the Notification
service_name = "Kumulos"
@@ -105,6 +106,7 @@ )
def __init__(self, apikey, serverkey, **kwargs):
+ """Initialize Kum... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/kumulos.py |
Replace inline comments with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -109,6 +109,7 @@
class LametricMode:
+ """Define Lametric Notification Modes."""
# App posts upstream to the developer API on Lametric's website
CLOUD = "cloud"
@@ -124,6 +125,7 @@
class LametricPriority:
+ """Priority of the message."""
# info: this priority means that notif... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/lametric.py |
Create documentation for each function signature | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -94,6 +94,7 @@
class NotifyMailgun(NotifyBase):
+ """A wrapper for Mailgun Notifications."""
# The default descriptive name associated with the Notification
service_name = "Mailgun"
@@ -222,6 +223,7 @@ batch=False,
**kwargs,
):
+ """Initialize Mailgun Object.""... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/mailgun.py |
Add docstrings to clarify complex logic | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -101,6 +101,7 @@
class NotifyJoin(NotifyBase):
+ """A wrapper for Join Notifications."""
# The default descriptive name associated with the Notification
service_name = "Join"
@@ -198,6 +199,7 @@ def __init__(
self, apikey, targets=None, include_image=True, priority=None, **kwa... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/join.py |
Add docstrings to meet PEP guidelines | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -51,6 +51,10 @@
class NotifyMacOSX(NotifyBase):
+ """A wrapper for the MacOS X terminal-notifier tool.
+
+ Source: https://github.com/julienXX/terminal-notifier
+ """
# Set our global enabled flag
enabled = NOTIFY_MACOSX_SUPPORT_ENABLED
@@ -128,6 +132,7 @@ )
def __init__(s... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/macosx.py |
Add docstrings for internal functions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -41,6 +41,7 @@
class NotifyLark(NotifyBase):
+ """A wrapper for Lark (Feishu) Notifications via Webhook."""
# The default descriptive name associated with the Notification
service_name = _("Lark (Feishu)")
@@ -73,6 +74,11 @@ )
def __init__(self, token, **kwargs):
+ """Ini... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/lark.py |
Add docstrings to incomplete code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -44,6 +44,7 @@
class NotifyLine(NotifyBase):
+ """A wrapper for Line Notifications."""
# The default descriptive name associated with the Notification
service_name = "Line"
@@ -113,6 +114,7 @@ )
def __init__(self, token, targets=None, include_image=True, **kwargs):
+ """I... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/line.py |
Document functions with clear intent | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -58,6 +58,7 @@
class MatrixDiscoveryException(AppriseException):
+ """Apprise Matrix Exception Class."""
# Extend HTTP Error Messages
@@ -86,6 +87,7 @@
class MatrixMessageType:
+ """The Matrix Message types."""
TEXT = "text"
NOTICE = "notice"
@@ -137,6 +139,7 @@
class Notif... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/matrix.py |
Write docstrings describing each step | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -38,6 +38,7 @@
class AttachMemory(AttachBase):
+ """A wrapper for Memory based attachment sources."""
# The default descriptive name associated with the service
service_name = _("Memory")
@@ -57,6 +58,7 @@ encoding="utf-8",
**kwargs,
):
+ """Initialize Memory B... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/attachment/memory.py |
Add clean documentation to messy code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -40,6 +40,10 @@
class CustomNotifyPlugin(NotifyBase):
+ """Apprise Custom Plugin Hook.
+
+ This gets initialized based on @notify decorator definitions
+ """
# Our Custom notification; identify the URL users can go to learn
# more about the service this wrapper supports:
@@ -60,13 +6... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/decorators/base.py |
Add docstrings for utility scripts | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -50,6 +50,7 @@
class BulkSMSRoutingGroup:
+ """The different categories of routing."""
ECONOMY = "ECONOMY"
STANDARD = "STANDARD"
@@ -65,6 +66,7 @@
class BulkSMSEncoding:
+ """The different categories of routing."""
TEXT = "TEXT"
UNICODE = "UNICODE"
@@ -72,6 +74,7 @@
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/bulksms.py |
Add well-formatted docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -51,6 +51,7 @@
class NotifyIFTTT(NotifyBase):
+ """A wrapper for IFTTT Notifications."""
# The default descriptive name associated with the Notification
service_name = "IFTTT"
@@ -137,6 +138,16 @@ def __init__(
self, webhook_id, events, add_tokens=None, del_tokens=None, **kwar... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/ifttt.py |
Help me write clear docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -80,6 +80,7 @@
class NotifyDapnet(NotifyBase):
+ """A wrapper for DAPNET / Hampager Notifications."""
# The default descriptive name associated with the Notification
service_name = "Dapnet"
@@ -173,6 +174,7 @@ def __init__(
self, targets=None, priority=None, txgroups=None, bat... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/dapnet.py |
Add well-formatted docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -68,6 +68,7 @@
class NotifyBrevo(NotifyBase):
+ """A wrapper for Notify Brevo Notifications."""
# The default descriptive name associated with the Notification
service_name = "Brevo"
@@ -164,6 +165,7 @@ bcc=None,
**kwargs,
):
+ """Initialize Notify Brevo Object... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/brevo.py |
Create Google-style docstrings for my code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -41,6 +41,7 @@
class NotifyChanify(NotifyBase):
+ """A wrapper for Chanify Notifications."""
# The default descriptive name associated with the Notification
service_name = _("Chanify")
@@ -90,6 +91,7 @@ )
def __init__(self, token, **kwargs):
+ """Initialize Chanify Object... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/chanify.py |
Create docstrings for API functions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -73,6 +73,7 @@
class NotifyKavenegar(NotifyBase):
+ """A wrapper for Kavenegar Notifications."""
# The default descriptive name associated with the Notification
service_name = "Kavenegar"
@@ -152,6 +153,7 @@ )
def __init__(self, apikey, source=None, targets=None, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/kavenegar.py |
Add docstrings including usage examples | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -221,6 +221,7 @@
class PersistentStorageMode:
+ """Persistent Storage Modes."""
# List all detected configuration loaded
LIST = "list"
@@ -245,6 +246,7 @@
def print_version_msg():
+ """Prints version message when -V or --version is specified."""
result = []
result.append(f... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/cli.py |
Add docstrings for better understanding | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,8 @@
class GoogleOAuth:
+ """A OAuth simplified implimentation to Google's Firebase Cloud
+ Messaging."""
scopes = [
"https://www.googleapis.com/auth/firebase.messaging",
@@ -64,6 +66,7 @@ def __init__(
self, user_agent=None, timeout=(5, 4), verify_certificate... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/fcm/oauth.py |
Document my Python code with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -42,6 +42,7 @@
class NotifyFreeMobile(NotifyBase):
+ """A wrapper for Free-Mobile Notifications."""
# The default descriptive name associated with the Notification
service_name = _("Free-Mobile")
@@ -88,6 +89,7 @@ )
def __init__(self, **kwargs):
+ """Initialize Free Mobil... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/freemobile.py |
Write clean docstrings for readability | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -87,6 +87,7 @@
class NotifyGotify(NotifyBase):
+ """A wrapper for Gotify Notifications."""
# The default descriptive name associated with the Notification
service_name = "Gotify"
@@ -158,6 +159,7 @@ )
def __init__(self, token, priority=None, **kwargs):
+ """Initialize Got... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/gotify.py |
Write reusable docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -65,6 +65,7 @@
class NotifyGoogleChat(NotifyBase):
+ """A wrapper to Google Chat Notifications."""
# The default descriptive name associated with the Notification
service_name = "Google Chat"
@@ -149,6 +150,7 @@ def __init__(
self, workspace, webhook_key, webhook_token, thread... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/google_chat.py |
Add standardized docstrings across the file | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -52,6 +52,7 @@
class RequirementsSpec(TypedDict, total=False):
+ """Defines our plugin requirements."""
packages_required: Optional[Union[str, list[str]]]
packages_recommended: Optional[Union[str, list[str]]]
@@ -59,6 +60,7 @@
class NotifyBase(URLBase):
+ """This is the base class f... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/base.py |
Document this script properly | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -90,6 +90,7 @@
class NotifyMSTeams(NotifyBase):
+ """A wrapper for Microsoft Teams Notifications."""
# The default descriptive name associated with the Notification
service_name = "MSTeams"
@@ -236,6 +237,13 @@ tokens=None,
**kwargs,
):
+ """Initialize Microsof... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/msteams.py |
Document this script properly | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -46,11 +46,15 @@
def trace(self, message, *args, **kwargs):
+ """
+ Verbose Debug Logging - Trace
+ """
if self.isEnabledFor(logging.TRACE):
self._log(logging.TRACE, message, args, **kwargs)
def deprecate(self, message, *args, **kwargs):
+ """Deprication Warning Logging."""... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/logger.py |
Add clean documentation to messy code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -51,6 +51,7 @@
class NotifyBlueSky(NotifyBase):
+ """A wrapper for BlueSky Notifications."""
# The default descriptive name associated with the Notification
service_name = "BlueSky"
@@ -129,6 +130,7 @@ )
def __init__(self, **kwargs):
+ """Initialize BlueSky Object."""
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/bluesky.py |
Document all endpoints with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -43,6 +43,8 @@
class PluginManager(metaclass=Singleton):
+ """Designed to be a singleton object to maintain all initialized loading of
+ modules in memory."""
# Description (used for logging)
name = "Singleton Plugin"
@@ -63,6 +65,7 @@ _lock = threading.Lock()
def __init__(se... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/manager.py |
Document my Python code with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -65,6 +65,7 @@
class NotifyDiscord(NotifyBase):
+ """A wrapper to Discord Notifications."""
# The default descriptive name associated with the Notification
service_name = "Discord"
@@ -224,6 +225,7 @@ ping: list[str] | None = None,
**kwargs: Any,
) -> None:
+ "... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/discord.py |
Write clean docstrings for readability | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -55,6 +55,7 @@
class NotifyClickSend(NotifyBase):
+ """A wrapper for ClickSend Notifications."""
# The default descriptive name associated with the Notification
service_name = "ClickSend"
@@ -134,6 +135,7 @@ )
def __init__(self, targets=None, batch=False, **kwargs):
+ """... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/clicksend.py |
Write beginner-friendly docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -64,6 +64,7 @@
class NotifyBurstSMS(NotifyBase):
+ """A wrapper for Burst SMS Notifications."""
# The default descriptive name associated with the Notification
service_name = "Burst SMS"
@@ -180,6 +181,7 @@ batch=None,
**kwargs,
):
+ """Initialize Burst SMS Obj... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/burstsms.py |
Add docstrings to meet PEP guidelines | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -25,6 +25,21 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""IRC Notifications.
+
+This is simplified IRC client designed for notification delivery.
+It focuses on reliability and predictable behaviour, not full IRC features.
+
+URL formats... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/irc/base.py |
Generate docstrings for each module | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -109,6 +109,7 @@
class NotifyAprs(NotifyBase):
+ """A wrapper for APRS Notifications via APRS-IS."""
# The default descriptive name associated with the Notification
service_name = "Aprs"
@@ -216,6 +217,7 @@ )
def __init__(self, targets=None, locale=None, delay=None, **kwargs):
+... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/aprs.py |
Create docstrings for all classes and functions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -36,6 +36,7 @@
class FORMPayloadField:
+ """Identifies the fields available in the FORM Payload."""
VERSION = "version"
TITLE = "title"
@@ -48,6 +49,7 @@
class NotifyForm(NotifyBase):
+ """A wrapper for Form Notifications."""
# Support
# - file*
@@ -182,6 +184,11 @@ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/custom_form.py |
Write Python docstrings for this snippet | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -61,6 +61,10 @@
class NotifyEmail(NotifyBase):
+ """
+ A wrapper to Email Notifications
+
+ """
# The default descriptive name associated with the Notification
service_name = "E-Mail"
@@ -217,6 +221,12 @@ pgp_key=None,
**kwargs,
):
+ """
+ Initiali... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/email/base.py |
Document all endpoints with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -39,6 +39,7 @@
class JSONPayloadField:
+ """Identifies the fields available in the JSON Payload."""
VERSION = "version"
TITLE = "title"
@@ -52,6 +53,7 @@
class NotifyJSON(NotifyBase):
+ """A wrapper for JSON Notifications."""
# The default descriptive name associated with the... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/custom_json.py |
Write docstrings describing each step | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -55,6 +55,7 @@
class MastodonMessageVisibility:
+ """The visibility of any status message made."""
# post visibility defaults to the accounts default-visibilty setting
DEFAULT = "default"
@@ -84,6 +85,7 @@
class NotifyMastodon(NotifyBase):
+ """A wrapper for Notify Mastodon Notifica... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/mastodon.py |
Add docstrings with type hints explained | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -32,12 +32,19 @@
class AppriseEmailException(ApprisePluginException):
+ """
+ Thrown when there is an error with the Email Attachment
+ """
def __init__(self, message, error_code=601):
super().__init__(message, error_code=error_code)
class WebBaseLogin:
+ """
+ This cl... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/email/common.py |
Write Python docstrings for this snippet | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -24,6 +24,23 @@ # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""
+Mattermost Notifications.
+
+This plugin supports 2 modes of operation:
+
+1. Webhook mode (default):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/mattermost.py |
Write docstrings for this repository | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -25,6 +25,17 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""IRC State Machine.
+
+The client reads IRC lines, parses them into :class:`IRCMessage`, and feeds
+them into :meth:`IRCStateMachine.on_message`. The return value is a list of
+:cl... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/irc/state.py |
Help me add docstrings to my project | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -52,6 +52,8 @@
class AppriseLocale:
+ """A wrapper class to gettext so that we can manipulate multiple lanaguages
+ on the fly if required."""
# Define our translation domain
_domain = "apprise"
@@ -76,6 +78,12 @@ _default_language = "en"
def __init__(self, language=None):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/locale.py |
Generate docstrings with parameter types | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -36,12 +36,37 @@
class NotificationPriority:
+ """
+ Defines the Notification Priorities as described on:
+ https://firebase.google.com/docs/reference/fcm/rest/v1/\
+ projects.messages#androidmessagepriority
+
+ NORMAL:
+ Default priority for data messages. Normal pr... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/fcm/priority.py |
Can you add docstrings to this Python file? | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -54,6 +54,7 @@
class MisskeyVisibility:
+ """The visibility of any note created."""
# post will be public
PUBLIC = "public"
@@ -75,6 +76,7 @@
class NotifyMisskey(NotifyBase):
+ """A wrapper for Misskey Notifications."""
# The default descriptive name associated with the Notif... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/misskey.py |
Add concise docstrings to each method | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -34,6 +34,7 @@
class NotifyPushMe(NotifyBase):
+ """A wrapper for PushMe Notifications."""
# The default descriptive name associated with the Notification
service_name = "PushMe"
@@ -85,6 +86,7 @@ )
def __init__(self, token, status=None, **kwargs):
+ """Initialize PushMe ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushme.py |
Create Google-style docstrings for my code | #
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain... | --- +++ @@ -42,6 +42,7 @@
class NotifyPushplus(NotifyBase):
+ """A wrapper for Pushplus Notifications."""
# The default descriptive name associated with the Notification
service_name = _("Pushplus")
@@ -74,6 +75,7 @@ )
def __init__(self, token, **kwargs):
+ """Initialize Pushplus Ob... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushplus.py |
Create documentation for each function signature | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -45,6 +45,7 @@
class NotifyPushed(NotifyBase):
+ """A wrapper to Pushed Notifications."""
# The default descriptive name associated with the Notification
service_name = "Pushed"
@@ -120,6 +121,7 @@ )
def __init__(self, app_key, app_secret, targets=None, **kwargs):
+ """In... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushed.py |
Add detailed docstrings explaining each function | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -51,6 +51,7 @@
class NotifyNotifiarr(NotifyBase):
+ """A wrapper for Notifiarr Notifications."""
# The default descriptive name associated with the Notification
service_name = "Notifiarr"
@@ -146,6 +147,11 @@ source=None,
**kwargs,
):
+ """Initialize Notifiarr ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/notifiarr.py |
Help me comply with documentation standards | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -48,6 +48,7 @@
class NotifyPushy(NotifyBase):
+ """A wrapper for Pushy Notifications."""
# The default descriptive name associated with the Notification
service_name = "Pushy"
@@ -124,6 +125,7 @@ )
def __init__(self, apikey, targets=None, sound=None, badge=None, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushy.py |
Include argument descriptions in docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -51,6 +51,7 @@
class MSG91PayloadField:
+ """Identifies the fields available in the JSON Payload."""
BODY = "body"
MESSAGETYPE = "type"
@@ -61,6 +62,7 @@
class NotifyMSG91(NotifyBase):
+ """A wrapper for MSG91 Notifications."""
# The default descriptive name associated with t... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/msg91.py |
Document helper functions with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -42,6 +42,7 @@
class PagerDutySeverity:
+ """Defines the Pager Duty Severity Levels."""
INFO = "info"
@@ -88,6 +89,7 @@
class NotifyPagerDuty(NotifyBase):
+ """A wrapper for Pager Duty Notifications."""
# The default descriptive name associated with the Notification
service... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pagerduty.py |
Create documentation strings for testing functions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -40,6 +40,7 @@
class NotifyMessageBird(NotifyBase):
+ """A wrapper for MessageBird Notifications."""
# The default descriptive name associated with the Notification
service_name = "MessageBird"
@@ -115,6 +116,7 @@ )
def __init__(self, apikey, source, targets=None, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/messagebird.py |
Help me document legacy Python code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -45,6 +45,7 @@
class RyverWebhookMode:
+ """Ryver supports to webhook modes."""
SLACK = "slack"
RYVER = "ryver"
@@ -58,6 +59,7 @@
class NotifyRyver(NotifyBase):
+ """A wrapper for Ryver Notifications."""
# The default descriptive name associated with the Notification
ser... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/ryver.py |
Expand my code with proper documentation strings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -53,9 +53,21 @@
class NextcloudGroupDiscoveryException(AppriseException):
+ """Apprise Nextcloud Group Discovery Exception Class."""
class NotifyNextcloud(NotifyBase):
+ """A wrapper for Nextcloud Notifications.
+
+ Targets can be individual users, groups, or everyone:
+ - user: specify ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/nextcloud.py |
Fully document this Python code with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -37,6 +37,7 @@
class NotifyPushjet(NotifyBase):
+ """A wrapper for Pushjet Notifications."""
# The default descriptive name associated with the Notification
service_name = "Pushjet"
@@ -105,6 +106,7 @@ )
def __init__(self, secret_key, **kwargs):
+ """Initialize Pushjet Ob... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushjet.py |
Write docstrings for this repository | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -56,6 +56,7 @@
class NotificationAPIRegion:
+ """Regions."""
CA = "ca"
US = "us"
@@ -78,6 +79,7 @@
class NotificationAPIChannel:
+ """Channels"""
EMAIL = "email"
SMS = "sms"
@@ -99,6 +101,7 @@
class NotificationAPIMode:
+ """Modes"""
TEMPLATE = "template"
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/notificationapi.py |
Add concise docstrings to each method | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -71,6 +71,8 @@
class SMSEagleCategory:
+ """We define the different category types that we can notify via SMS
+ Eagle."""
PHONE = "phone"
GROUP = "group"
@@ -85,6 +87,7 @@
class NotifySMSEagle(NotifyBase):
+ """A wrapper for SMSEagle Notifications."""
# The default descrip... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/smseagle.py |
Generate docstrings for exported functions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -59,6 +59,7 @@
class NotifyParsePlatform(NotifyBase):
+ """A wrapper for Parse Platform Notifications."""
# The default descriptive name associated with the Notification
service_name = "Parse Platform"
@@ -131,6 +132,7 @@ )
def __init__(self, app_id, master_key, device=None, **k... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/parseplatform.py |
Write docstrings describing functionality | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -57,6 +57,7 @@
class OpsgenieCategory(NotifyBase):
+ """We define the different category types that we can notify."""
USER = "user"
SCHEDULE = "schedule"
@@ -73,6 +74,7 @@
class OpsgenieAlertAction:
+ """Defines the supported actions."""
# Use mapping (specify :key=arg to ove... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/opsgenie.py |
Add docstrings to incomplete code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,7 @@
class SinchRegion:
+ """Defines the Sinch Server Regions."""
USA = "us"
EUROPE = "eu"
@@ -57,6 +58,7 @@
class NotifySinch(NotifyBase):
+ """A wrapper for Sinch Notifications."""
# The default descriptive name associated with the Notification
service_name =... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/sinch.py |
Improve my code by adding docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -56,6 +56,7 @@
class NotifySimplePush(NotifyBase):
+ """A wrapper for SimplePush Notifications."""
# Set our global enabled flag
enabled = NOTIFY_SIMPLEPUSH_ENABLED
@@ -129,6 +130,7 @@ )
def __init__(self, apikey, event=None, **kwargs):
+ """Initialize SimplePush Object."... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/simplepush.py |
Add docstrings to meet PEP guidelines | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -77,6 +77,7 @@
class NotifyPagerTree(NotifyBase):
+ """A wrapper for PagerTree Notifications."""
# The default descriptive name associated with the Notification
service_name = "PagerTree"
@@ -163,6 +164,7 @@ meta_extras=None,
**kwargs,
):
+ """Initialize PagerT... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pagertree.py |
Add docstrings to improve readability | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,7 @@
class NotifySignalAPI(NotifyBase):
+ """A wrapper for SignalAPI Notifications."""
# The default descriptive name associated with the Notification
service_name = "Signal API"
@@ -166,6 +167,7 @@ def __init__(
self, source=None, targets=None, batch=False, status=F... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/signal_api.py |
Add clean documentation to messy code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -45,6 +45,8 @@
class OneSignalCategory:
+ """We define the different category types that we can notify via
+ OneSignal."""
PLAYER = "include_player_ids"
EMAIL = "include_email_tokens"
@@ -61,6 +63,7 @@
class NotifyOneSignal(NotifyBase):
+ """A wrapper for OneSignal Notifications.... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/one_signal.py |
Create docstrings for reusable components | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -42,6 +42,9 @@
class NotifySIGNL4(NotifyBase):
+ """
+ A wrapper for SIGNL4 Notifications
+ """
# The default descriptive name associated with the Notification
service_name = "SIGNL4"
@@ -117,6 +120,9 @@ status: Optional[str] = None,
**kwargs: Any
) -> None:
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/signl4.py |
Generate NumPy-style docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -40,6 +40,7 @@
class NotifyPopcornNotify(NotifyBase):
+ """A wrapper for PopcornNotify Notifications."""
# The default descriptive name associated with the Notification
service_name = "PopcornNotify"
@@ -108,6 +109,7 @@ )
def __init__(self, apikey, targets=None, batch=False, **k... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/popcorn_notify.py |
Generate consistent documentation across files | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -113,6 +113,7 @@
class NotifySES(NotifyBase):
+ """A wrapper for AWS SES (Amazon Simple Email Service)"""
# The default descriptive name associated with the Notification
service_name = "AWS Simple Email Service (SES)"
@@ -234,6 +235,7 @@ bcc=None,
**kwargs,
):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/ses.py |
Add inline docstrings for readability | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -85,6 +85,7 @@
class NotifyNotifico(NotifyBase):
+ """A wrapper for Notifico Notifications."""
# The default descriptive name associated with the Notification
service_name = "Notifico"
@@ -158,6 +159,7 @@ )
def __init__(self, project_id, msghook, color=True, prefix=True, **kwarg... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/notifico.py |
Expand my code with proper documentation strings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -52,6 +52,7 @@
class NotifySFR(NotifyBase):
+ """A wrapper for SFR French Telecom DMC API."""
# The default descriptive name associated with the Notification
service_name = _("Société Française du Radiotéléphone")
@@ -170,6 +171,7 @@ voice=None,
**kwargs,
):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/sfr.py |
Add docstrings for utility scripts | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,7 @@
class NotifyRevolt(NotifyBase):
+ """A wrapper for Revolt Notifications."""
# The default descriptive name associated with the Notification
service_name = "Revolt"
@@ -177,6 +178,7 @@ return
def send(self, body, title="", notify_type=NotifyType.INFO, **kwargs)... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/revolt.py |
Add docstrings to clarify complex logic | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -57,6 +57,7 @@
class NotifyTwist(NotifyBase):
+ """A wrapper for Notify Twist Notifications."""
# The default descriptive name associated with the Notification
service_name = "Twist"
@@ -136,6 +137,7 @@ )
def __init__(self, email=None, targets=None, **kwargs):
+ """Initia... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/twist.py |
Add clean documentation to messy code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -45,6 +45,7 @@
class WebPushSubscription:
+ """WebPush Subscription."""
# Format:
# {
@@ -55,6 +56,8 @@ # }
# }
def __init__(self, content: Union[str, dict, None] = None) -> None:
+ """Prepares a webpush object provided with content Content can be a
+ dictio... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/vapid/subscription.py |
Create documentation for each function signature | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -61,6 +61,7 @@
class TwilioNotificationMethod:
+ """Twilio Notification Method."""
SMS = "sms"
CALL = "call"
@@ -73,6 +74,7 @@
class TwilioMessageMode:
+ """Twilio Message Mode."""
# SMS/MMS
TEXT = "T"
@@ -82,6 +84,7 @@
class NotifyTwilio(NotifyBase):
+ """A wrapp... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/twilio.py |
Create Google-style docstrings for my code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -43,6 +43,7 @@
class ThreemaRecipientTypes:
+ """The supported recipient specifiers."""
THREEMA_ID = "to"
PHONE = "phone"
@@ -50,6 +51,7 @@
class NotifyThreema(NotifyBase):
+ """A wrapper for Threema Gateway Notifications."""
# The default descriptive name associated with the... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/threema.py |
Please document this code using docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -37,6 +37,7 @@
class NotifyPushDeer(NotifyBase):
+ """A wrapper for PushDeer Notifications."""
# The default descriptive name associated with the Notification
service_name = "PushDeer"
@@ -91,6 +92,7 @@ )
def __init__(self, pushkey, **kwargs):
+ """Initialize PushDeer Obj... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushdeer.py |
Add detailed documentation for each class | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -25,6 +25,7 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""XMPP Notifications"""
from __future__ import annotations
@@ -56,6 +57,7 @@
class NotifyXMPP(NotifyBase):
+ """Send notifications via XMPP using Slixmpp."""
# Set... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/xmpp/base.py |
Generate missing documentation strings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -25,6 +25,10 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""A minimal, self-contained Slixmpp adapter.
+
+This module provides a wrapper to Slixmpp for Apprise.
+"""
from __future__ import annotations
@@ -61,6 +65,7 @@
@dataclass(fr... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/xmpp/adapter.py |
Write docstrings for utility functions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -82,6 +82,7 @@
class SparkPostRegion:
+ """Regions."""
US = "us"
EU = "eu"
@@ -101,6 +102,7 @@
class NotifySparkPost(NotifyBase):
+ """A wrapper for SparkPost Notifications."""
# The default descriptive name associated with the Notification
service_name = "SparkPost"
@@ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/sparkpost.py |
Add well-formatted docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -45,6 +45,7 @@
class NotifyVoipms(NotifyBase):
+ """A wrapper for VoIPms Notifications."""
# The default descriptive name associated with the Notification
service_name = "VoIPms"
@@ -124,6 +125,7 @@ )
def __init__(self, email, source=None, targets=None, **kwargs):
+ """In... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/voipms.py |
Write docstrings that follow conventions | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,7 @@
class SMSManagerGateway:
+ """The different gateway values."""
HIGH = "high"
ECONOMY = "economy"
@@ -64,6 +65,7 @@
class NotifySMSManager(NotifyBase):
+ """A wrapper for SMS Manager Notifications."""
# The default descriptive name associated with the Notificati... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/smsmanager.py |
Write docstrings for backend logic | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -66,6 +66,7 @@
class NotifyWeComBot(NotifyBase):
+ """A wrapper for WeCom Bot Notifications."""
# The default descriptive name associated with the Notification
service_name = "WeCom Bot"
@@ -116,6 +117,7 @@ )
def __init__(self, key, **kwargs):
+ """Initialize WeCom Bot Ob... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/wecombot.py |
Document functions with detailed explanations | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -42,6 +42,7 @@
class NotifyVonage(NotifyBase):
+ """A wrapper for Vonage Notifications."""
# The default descriptive name associated with the Notification
service_name = "Vonage"
@@ -144,6 +145,7 @@ def __init__(
self, apikey, secret, source, targets=None, ttl=None, **kwargs
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/vonage.py |
Document all public functions with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -74,6 +74,7 @@
class NotifyStreamlabs(NotifyBase):
+ """A wrapper to Streamlabs Donation Notifications."""
# The default descriptive name associated with the Notification
service_name = "Streamlabs"
@@ -189,6 +190,7 @@ identifier="Apprise",
**kwargs,
):
+ """In... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/streamlabs.py |
Create docstrings for reusable components | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -25,6 +25,10 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
+"""Utilities that make payloads safe to *print* in debug and trace logs.
+
+This module is intentionally scoped to log presentation only.
+"""
from __future__ import annotations
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/sanitize.py |
Write beginner-friendly docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -38,6 +38,7 @@
class NotifyXBMC(NotifyBase):
+ """A wrapper for XBMC/KODI Notifications."""
# The default descriptive name associated with the Notification
service_name = "Kodi/XBMC"
@@ -134,6 +135,7 @@ )
def __init__(self, include_image=True, duration=None, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/xbmc.py |
Write docstrings including parameters and return values | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -34,6 +34,7 @@
class SyslogFacility:
+ """All of the supported facilities."""
KERN = "kern"
USER = "user"
@@ -107,6 +108,7 @@
class NotifySyslog(NotifyBase):
+ """A wrapper for Syslog Notifications."""
# The default descriptive name associated with the Notification
servi... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/syslog.py |
Document all public functions with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -36,6 +36,23 @@ match_all=common.MATCH_ALL_TAG,
match_always=common.MATCH_ALWAYS_TAG,
):
+ """The data variable should always be a set of strings that the logic can
+ be compared against. It should be a set. If it isn't already, then it will
+ be converted as such. These identify the tags... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/logic.py |
Please document this code using docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -69,12 +69,14 @@
class ApprisePEMException(ApprisePluginException):
+ """Thrown when there is an error with the PEM Controller."""
def __init__(self, message, error_code=612):
super().__init__(message, error_code=error_code)
class ApprisePEMController:
+ """PEM Controller Tool ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/pem.py |
Document this code for team use | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -58,10 +58,17 @@
def path_decode(path):
+ """Returns the fully decoded path based on the operating system."""
return os.path.abspath(__PATH_DECODER(path))
def tidy_path(path):
+ """Take a filename and or directory and attempts to tidy it up by removing
+ trailing slashes and correcting... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/disk.py |
Add docstrings to incomplete code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -63,6 +63,7 @@
class NotifySMTP2Go(NotifyBase):
+ """A wrapper for SMTP2Go Notifications."""
# The default descriptive name associated with the Notification
service_name = "SMTP2Go"
@@ -173,6 +174,7 @@ batch=False,
**kwargs,
):
+ """Initialize SMTP2Go Object.""... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/smtp2go.py |
Write docstrings describing each step | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -44,9 +44,26 @@
class AppriseSocketError(AppriseException):
+ """Raised for socket or TLS related failures."""
class SocketTransport:
+ """
+ TCP client transport with optional TLS upgrade.
+
+ Behaviour:
+ - secure=False (default): plain TCP
+ - secure=True: upgrade to TLS (im... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/socket.py |
Write beginner-friendly docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -78,6 +78,7 @@
class WxPusherContentType:
+ """Defines the different supported content types."""
TEXT = 1
HTML = 2
@@ -92,6 +93,7 @@
class NotifyWxPusher(NotifyBase):
+ """A wrapper for WxPusher Notifications."""
# The default descriptive name associated with the Notification... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/wxpusher.py |
Create docstrings for each class method | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -30,8 +30,25 @@
def cwe312_word(word, force=False, advanced=True, threshold=5):
+ """This function was written to help mask secure/private information that
+ may or may not be found within Apprise. The idea is to provide a
+ presentable word response that the user who prepared it would understan... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/cwe312.py |
Provide clean and structured docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -52,6 +52,7 @@
class NotifyWhatsApp(NotifyBase):
+ """A wrapper for WhatsApp Notifications."""
# The default descriptive name associated with the Notification
service_name = "WhatsApp"
@@ -179,6 +180,7 @@ template_mapping=None,
**kwargs,
):
+ """Initialize What... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/whatsapp.py |
Add structured docstrings to improve clarity | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -39,6 +39,7 @@
class NotifySynology(NotifyBase):
+ """A wrapper for Synology Chat Notifications."""
# The default descriptive name associated with the Notification
service_name = "Synology Chat"
@@ -130,6 +131,11 @@ }
def __init__(self, token=None, headers=None, file_url=None, *... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/synology.py |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.