Skip to main content

User notification library with pluggable backends. Compatible with popular frameworks such as Django, Flask, Celery.

Project description

Pluggable notifications for your Python apps.

yell is not a notification storage or delivery backend but a set of APIs that make it easy to add your own delivery mechanisms.

The full documentation is available here.

Using notification decorators

from yell import notify
from yell.decorators import notification

@notification(name = 'buffalo')
def buffalo_printer(message):
    print message

@notification(name = 'buffalo')
def buffalo_saver(message):
    save(message)

notify("buffalo", _("Buffalo buffalo Buffalo buffalo buffalo buffalo Buffalo buffalo"))

Using notification classes

from yell import Notification, notify

class Buffalo(Notification):
    name = "buffalo"
    message = _("Buffalo buffalo Buffalo buffalo buffalo buffalo Buffalo buffalo")

    def notify(self, *args, **kwargs):
        print self.message

class BuffaloEmail(Buffalo):
    def notify(self, *args, **kwargs):
        send_mail("Buffalo", self.message, 'buffalo@example.com', [kwargs.get('user').email])

class BuffaloDatabase(Buffalo):
    def notify(self, *args, **kwargs):
        BuffaloModel.objects.create(user = kwargs.get('user'))

# The default behaviour is to use every notification backend with the same
# name
notify("buffalo", user = User.objects.get(id=1))

# Only send emails
notify("buffalo", user = User.objects.get(id=1), backends = [BuffaloEmail])

Changelog

v0.3

  • backwards incompatible Guessing the file extension with the mimetypes package proved to be inconsistent across systems. TemplatedEmailBackend now makes use of explicitly declared file extensions.

v0.2

  • Made the API saner to use (backwards incompatible):

    • yell.Yell became yell.Notification

    • yell.yell became yell.notify

    • yell.decorators.yelling became yell.decorators.notification

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yell-0.3.tar.gz (5.8 kB view details)

Uploaded Source

File details

Details for the file yell-0.3.tar.gz.

File metadata

  • Download URL: yell-0.3.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for yell-0.3.tar.gz
Algorithm Hash digest
SHA256 7fb838d5e1442fb76c172c735bca62a434cf7b9e762871b1f4e45b9b20120fe1
MD5 8f4f383b87304b479582fc2a39961d87
BLAKE2b-256 b7c029a7a1c36a825a9e1ea7c8450d4c526fe26e4302445cc5ed51664074849a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page