Skip to main content

common email templates and functions

Project description

https://travis-ci.org/UrbanCCD-UChicago/plenario-mailer-core.svg?branch=master https://coveralls.io/repos/github/UrbanCCD-UChicago/plenario-mailer-core/badge.svg?branch=master

Usage

This package has a handful of useful shortcuts to send informational emails to data set contributors and admins. The functions can be wired up to be used with the data set event signals provided in plenario-core. For example:

from plenario_core.signals import data_set_approved
from plenario_core_mailer import mailer

def notify_approval(meta_model: MetaBase) -> None:
    mailer.send_data_set_approved(meta_model)

data_set_approved.connect(notify_approval)

Now, when a data set is marked as approved, plenario-core will fire off the signal and the defined handler will pick it up and call the mailer function.

Development

Fire up a virtualenv and install the dev requirements:

$ python3.6 -m venv .env
$ source .env/bin/activate
$ pip install -r dev-requirements.txt

To run the tests, in a separate terminal pull in the PostGIS docker image and create the database:

$ docker pull mdillon/postgis
$ docker run -d -p 5432:5432 mdillon/postgis
$ docker ps
...
$ docker exec -it {container hash} /bin/bash
...
# su postgres -c psql
...
> create database plenario;

Then all you have to do is run the tests normally:

$ coverage run manage.py test
$ coverage report
$ flake8

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

plenario_mailer_core-0.0.2-py3-none-any.whl (10.5 kB view hashes)

Uploaded Python 3

Supported by

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