Django Growl Notifier Logo

User Guide

  • Installation
    • Requirements
    • Via pip
    • From Source
    • Development Installation
    • Growl Setup
      • Windows
      • macOS
      • Linux
    • Verifying Installation
    • Next Steps
  • Quick Start Guide
    • Step 1: Install
    • Step 2: Configure Django
    • Step 3: Configure Growl Hosts
    • Step 4: Run Your Server
    • What’s Next?
    • Basic Usage Example
  • Configuration
    • Required Settings
      • GROWL_HOSTS
    • Optional Settings
      • GROWL_APP_NAME
      • GROWL_ENABLED
      • GROWL_ICON
      • GROWL_NOTIFY_ERRORS
      • GROWL_STICKY_ERRORS
      • GROWL_STICKY_SERVER
    • Complete Configuration Example
    • Environment-Specific Configuration
    • Environment Variables
    • Next Steps
  • Usage Guide
    • Automatic Notifications
      • Server Start Notifications
      • Error Notifications
    • Manual Notifications
      • Basic Notification
      • With All Options
      • Notification Types
    • Programmatic Control
      • Get Notifier Instance
      • Check Configuration
    • Conditional Notifications
      • Based on Environment
      • Based on User
    • Integration Examples
      • With Django Views
      • With Celery Tasks
      • With Management Commands
      • With Django Signals
    • Best Practices
    • Next Steps
  • Examples 1
    • Example 1: View Notifications
    • Example 2: Celery Task Monitoring
    • Example 3: Custom Management Command
    • Example 4: Django Admin Actions
    • Example 5: Django Signals
    • Example 6: REST API Integration
    • Example 7: Scheduled Tasks (Cron)
    • Example 8: Conditional Notifications
    • Example 9: Progress Monitoring
    • Example 10: Multi-Environment Setup
    • More Examples
  • Examples 2
    • Basic Examples
      • Simple Notification
      • With Custom Icon
      • Sticky Notification
    • Django Integration
      • In Views
      • With Celery
      • Management Commands
      • Django Admin
      • Django Signals
    • Advanced Examples
      • Conditional Notifications
      • Rate-Limited Notifications
      • Notification Queue
    • Testing Examples
      • Unit Testing with Notifications
      • Integration Testing
    • More Examples

API Reference

  • Notifier API
    • GrowlNotifier
      • GrowlNotifier.__init__()
      • GrowlNotifier.notify()
    • get_growl_notifier()
    • send_notification()
    • Classes
      • GrowlNotifier
        • GrowlNotifier.growl_hosts
        • GrowlNotifier.app_name
        • GrowlNotifier.enabled
        • GrowlNotifier.icon
        • GrowlNotifier.notifiers
    • Functions
      • get_growl_notifier
      • send_notification
    • Constants
      • Notification Types
  • Middleware API
    • GrowlErrorMiddleware
      • GrowlErrorMiddleware.__init__()
      • GrowlErrorMiddleware.process_exception()
    • GrowlErrorMiddleware
      • GrowlErrorMiddleware.notify_errors
      • GrowlErrorMiddleware.sticky_errors
      • Methods
      • Usage Example
      • Disabling Error Notifications
  • Management Commands
    • runserver_growl
      • Usage
      • Features
      • Notification Details
      • Command Class
      • Comparison with Standard runserver
      • When to Use
      • Implementation
      • See Also

Additional Information

  • Troubleshooting
    • Common Issues
      • Notifications Not Appearing
      • Notifications Work Locally But Not on Remote Hosts
      • Icons Not Showing
      • Error Notifications Not Working
      • Duplicate Notifications
      • Connection Timeout
      • Package Import Errors
    • Debugging Tips
      • Enable Verbose Logging
      • Test Notification Manually
      • Check Notifier Status
    • Performance Issues
      • Notifications Slowing Down Application
    • Getting Help
    • Useful Commands
    • Next Steps
  • Changelog
    • [1.0.4] - 2025-12-03
      • Added
      • Features
    • [Unreleased]
  • Contributing
    • Ways to Contribute
    • Getting Started
      • 1. Fork the Repository
      • 2. Clone Your Fork
      • 3. Create a Virtual Environment
      • 4. Install Development Dependencies
    • Development Workflow
      • 1. Create a Branch
      • 2. Make Your Changes
      • 3. Write Tests
      • 4. Format Code
      • 5. Update Documentation
      • 6. Commit Changes
      • 7. Push and Create Pull Request
    • Code Style
    • Testing
    • Documentation
    • Reporting Bugs
    • Suggesting Features
    • Pull Request Guidelines
    • Code Review Process
    • Questions?
    • Thank You!
  • License
    • MIT License
    • About the License
    • Dependencies
      • gntp
      • Django
    • Third-Party Licenses
Django Growl Notifier
  • Search

© Copyright 2025, Hadi Cahyadi.

Built with Sphinx using a theme provided by Read the Docs.