Skip to main content

A notification app for Django

Project description

Build Status Coverage Status Documentation Project on PyPI

Django vox is a django app that allow you to create and issue different types of notifications. Notifications can have different kinds of parameters which allow for convenient editing in the admin.

Features

  • Add and edit notifications from the admin

  • Built-in message editor provides drop-down of available template variables and supports previewing

  • Supports many backends: email (html & text), SMS (Twilio), Twitter, Slack, Postmark, XMPP, JSON webhooks, and Activity Streams

  • Supports attachments

  • Built in site contacts that can be used to send emails to admins, or update your organization‘s Twitter account, or send out webhooks

  • Flexible API allows you to define your own user preferences about which user gets which kind of notification

  • Set custom “from” addresses

  • Send messages in bulk (all together) or individually customized messages

Why this exists

TLDR: Because I am lazy and I don’t want to spend my evening doing a deploy just because marketing wants to update the text in their latest spam mail.

In a few more words:

  • Editing copy for notifications shouldn’t have to be done by programmers. This means:

    1. The notification templates should be editable in the admin

    2. The information necessary to correctly make a template, whether it’s a template ID or parameters) should be available in the admin page. It shouldn’t be necessary to look through source code just to make a notification work.

    3. Number 2 is actually a fairly difficult problem.

  • People have different ways of interacting with computers, and one way of doing notifications (i.e. email) doesn’t always make sense.

    1. Added to that, sending a text message that’s as verbose as an HTML email is simply ridiculous. Each medium begets its own kind of content.

    2. Since, as we mentioned earlier, content should be manageable by non-programmers, the different ways of sending messages should be manageable by non-programmers.

I want it, stat!

Well, why don’t you just head over to the documentation and we’ll get you started. A word of warning, it’s not super simple to setup, but it’s worth it.

CHANGES

3.6

  • Fix bug in notification editor where switching one template’s backend would alter the state of the another template form.

  • Add more tests

  • Make Backend.send_message an instance method, and instantiate backend objects when sending messages. This is a significant API change, but it’s unlikely to actually cause backwards compatibility issues.

  • Add title to notify page

3.5.3

  • Fix bugs in demo caused by slug

  • Add icon

3.5.2

  • Add better support and testing for non-ID primary keys

3.5.1

  • Fix packaging problem (missing files)

3.5

  • Fix some javascript problems on Django 2.1 & 2.2

  • Add one-time message admin actions

3.4

  • Fix crash when a non VoxModel model is registered

3.3

  • Pin to a newer version of august, it works much better

  • Be slightly more sophisticated with our activity data parsing

3.2

  • fix implementation of activity_type parameter

  • Fix bug issuing notifications with non VoxModel objects

  • Fix bug where django will crash if to_addresses is a generator

  • Omit skipping message when notification is not from code

  • Fix bug where we kept recreating notifications

  • Keep orphaned notifications with templates so we don’t delete data

3.1

  • Add ability to remove notifications of deleted classes

  • Fix error in notification editor when using grappelli

3.0

  • Rewrite that add support for multiple participants

2.3

  • add read_at field on inbox items

  • Users should be posting read activities to outbox, duh

2.2

  • Add the ability to post to inboxes and read messages

2.1

  • Redo activity schema so that its more straightforward

  • fix bug in background_task implementation

2.0.0

  • Add activity backend

1.1.0

  • Replace newlines in subject with space

  • Add support for resending failed messages

  • A few improvements to the admin

  • Add Grappelli compatibility

1.0.0

First stable release

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

django-vox-3.6.0.tar.gz (114.6 kB view details)

Uploaded Source

Built Distribution

django_vox-3.6.0-py3-none-any.whl (104.2 kB view details)

Uploaded Python 3

File details

Details for the file django-vox-3.6.0.tar.gz.

File metadata

  • Download URL: django-vox-3.6.0.tar.gz
  • Upload date:
  • Size: 114.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for django-vox-3.6.0.tar.gz
Algorithm Hash digest
SHA256 3bd90b826d2f34c79dff69822da5438210e12153c5c57a761e150ca6854c6f7f
MD5 34bf884ee3db1f149c5319241ff3cb68
BLAKE2b-256 d0e07812f1dbf4366f1af7a8e3328c55ae4f08e9493e8fff9de4f6c6aee68785

See more details on using hashes here.

File details

Details for the file django_vox-3.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_vox-3.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fe9105e3a5d6b920c2811f085f4aebf315f56969df11a06bbbc19e7b1849d1dd
MD5 018cc4a6083fd62dc6be5293ab9c0dbd
BLAKE2b-256 073c1989853328f09980fb02a467cd962f28a40a47dec046d5ea96a6271b9bbe

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