Configuration-Aware API

[gntp]
hostname = growl.example.com
password = mypassword
port = 23053

def mini(description, **kwargs):
    """
    Single notification function using config-aware GrowlNotifier.
    
    Reads default hostname, password, and port from ~/.gntp configuration file.
    All parameters from gntp.notifier.mini() are supported.
    
    Parameters:
    - description (str): Notification message (required)
    - **kwargs: All parameters supported by gntp.notifier.mini()
    
    Returns:
    bool or tuple: True on success, error tuple on failure
    """

class GrowlNotifier(gntp.notifier.GrowlNotifier):
    """
    ConfigParser enhanced GrowlNotifier object.
    
    Reads default values from ~/.gntp configuration file before applying
    constructor parameters. Configuration file settings are overridden by
    explicit constructor arguments.
    """
    
    def __init__(self, *args, **kwargs):
        """
        Initialize config-aware GrowlNotifier.
        
        Reads ~/.gntp configuration file and uses those values as defaults.
        Explicit constructor arguments override configuration file values.
        
        Parameters:
        Same as gntp.notifier.GrowlNotifier, with config file providing defaults
        
        Configuration Resolution Order:
        1. Built-in defaults (hostname='localhost', port=23053, password=None)
        2. ~/.gntp configuration file values
        3. Constructor arguments (highest priority)
        """

[gntp]
hostname = growl.mycompany.com
password = company-growl-password
port = 23053

import gntp.config

# Uses settings from ~/.gntp automatically
gntp.config.mini("Deployment completed successfully!")

# Config settings are used as defaults, can be overridden
gntp.config.mini(
    "Critical error occurred",
    hostname="emergency-server.com",  # Overrides config file
    priority=2
)

import gntp.config

# Create notifier using configuration file defaults
app = gntp.config.GrowlNotifier(
    applicationName="Web Server Monitor",
    notifications=["Server Down", "High Load", "Disk Full"],
    defaultNotifications=["Server Down", "Disk Full"]
    # hostname, password, port read from ~/.gntp
)

# Register and send notifications
app.register()

app.notify(
    "High Load",
    "Server Load Warning",
    "CPU usage is 89% for the last 5 minutes"
)

import gntp.config

# Some settings from config file, others specified at runtime
app = gntp.config.GrowlNotifier(
    applicationName="Backup System",
    notifications=["Backup Started", "Backup Completed", "Backup Failed"],
    # Use different server than config file for backup notifications
    hostname="backup-alerts.company.com",
    # But still use password from config file
)

app.register()
app.notify("Backup Started", "Daily Backup", "Starting backup of /home")

import gntp.config
import logging

# The config module gracefully handles missing ~/.gntp file
# Falls back to standard defaults if file doesn't exist or has no [gntp] section

logging.basicConfig(level=logging.INFO)

# This works even if ~/.gntp doesn't exist
gntp.config.mini("Application started")

# You can check if config was loaded by examining log output
# "Info reading ~/.gntp config file" appears if file is missing/invalid

[gntp]
hostname = notifications.company.com
password = enterprise-password-2023
port = 23053

import gntp.config

# Automatically uses enterprise settings
build_notifier = gntp.config.GrowlNotifier(
    applicationName="CI/CD Pipeline",
    notifications=["Build Started", "Build Success", "Build Failed"]
)

deployment_notifier = gntp.config.GrowlNotifier(
    applicationName="Deployment System", 
    notifications=["Deploy Started", "Deploy Success", "Deploy Failed"]
)

monitoring_notifier = gntp.config.GrowlNotifier(
    applicationName="System Monitor",
    notifications=["Alert", "Warning", "Info"]
)

# All three use the same enterprise Growl server automatically

[gntp]
# Growl server hostname or IP address
hostname = growl.example.com

# Network password for authentication (optional)
password = your-password-here

# Growl server port number
port = 23053