Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Django app for sending notifications.

Project description

django-ilmoitin

Latest PyPI version Python versions

A templated Django messaging library

Installation

  1. pip install django-ilmoitin

  2. Add django_ilmoitin to INSTALLED_APPS.

Usage

  1. django-ilmoitin uses django-mailer to send emails, so you need to configure the MAILER_EMAIL_BACKEND setting to let django-mailer know, how to actually send the mail:
MAILER_EMAIL_BACKEND = "your.actual.EmailBackend"
  1. Create a notifications.py file in django app and register your notification types:
from django_ilmoitin.registry import notifications

notifications.register("event_created", "Event created")
  1. Create a dummy_context.py file in django app and add dummy context data:
from django_ilmoitin.dummy_context import dummy_context

from .models import MyModel

model = MyModel(foo="bar")

dummy_context.context.update({
    "model": model
})
  1. Import notifications and dummy context in your apps.py:
from django.apps import AppConfig


class ExampleConfig(AppConfig):
    name = "example"

    def __init__(self, *args, **kwargs):
        super(ExampleConfig, self).__init__(*args, **kwargs)
        import example.notifications

    def ready(self):
        import example.dummy_context
  1. Go to django admin and add notification templates to your notifications

  2. Send notifications:

from django_ilmoitin.utils import send_notification

context = {
    "foo": "bar",
}
send_notification("foo@bar.com", "event_created", context)

Code format

This project uses black for Python code formatting. We follow the basic config, without any modifications. Basic black commands:

  • To let black do its magic: black .
  • To see which files black would change: black --check .

Project details


Download files

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

Files for django-ilmoitin, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size django_ilmoitin-0.1.2-py2-none-any.whl (9.5 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size django_ilmoitin-0.1.2.tar.gz (8.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page