73 lines
3.1 KiB
HTML
73 lines
3.1 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
|
<html>
|
||
|
|
<!-- Released 2020 under GPL3 -->
|
||
|
|
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<title>Overview (Grassroots Economics CIC notify 0.2.0)</title>
|
||
|
|
|
||
|
|
<meta name="description" content="Overview (Grassroots Economics CIC notify 0.2.0)">
|
||
|
|
<meta name="keywords" content="Overview (Grassroots Economics CIC notify 0.2.0)">
|
||
|
|
<meta name="resource-type" content="document">
|
||
|
|
<meta name="distribution" content="global">
|
||
|
|
<meta name="Generator" content="makeinfo">
|
||
|
|
<link href="index.html" rel="start" title="Top">
|
||
|
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||
|
|
<link href="index.html" rel="up" title="Top">
|
||
|
|
<link href="Setup.html" rel="next" title="Setup">
|
||
|
|
<link href="index.html" rel="prev" title="Top">
|
||
|
|
<style type="text/css">
|
||
|
|
<!--
|
||
|
|
a.summary-letter {text-decoration: none}
|
||
|
|
blockquote.indentedblock {margin-right: 0em}
|
||
|
|
div.display {margin-left: 3.2em}
|
||
|
|
div.example {margin-left: 3.2em}
|
||
|
|
div.lisp {margin-left: 3.2em}
|
||
|
|
kbd {font-style: oblique}
|
||
|
|
pre.display {font-family: inherit}
|
||
|
|
pre.format {font-family: inherit}
|
||
|
|
pre.menu-comment {font-family: serif}
|
||
|
|
pre.menu-preformatted {font-family: serif}
|
||
|
|
span.nolinebreak {white-space: nowrap}
|
||
|
|
span.roman {font-family: initial; font-weight: normal}
|
||
|
|
span.sansserif {font-family: sans-serif; font-weight: normal}
|
||
|
|
ul.no-bullet {list-style: none}
|
||
|
|
-->
|
||
|
|
</style>
|
||
|
|
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body lang="en">
|
||
|
|
<span id="Overview"></span><div class="header">
|
||
|
|
<p>
|
||
|
|
Next: <a href="Setup.html" accesskey="n" rel="next">Setup</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||
|
|
</div>
|
||
|
|
<hr>
|
||
|
|
<span id="Overview-1"></span><h2 class="chapter">1 Overview</h2>
|
||
|
|
|
||
|
|
<p>This system is in early stages of development. It is intended to be a flexible notification broker where additional notification targets easily can be plugged in.
|
||
|
|
</p>
|
||
|
|
<p>The framework is designed to asynchronously execute all tasks belonging to a specific context, based on the name of the task.
|
||
|
|
</p>
|
||
|
|
<p>Currently, only handlers for <strong>sms</strong> notifications are implemented. Any task with a <code>notify.sms.</code> prefix registered in the celery task worker pool will be executed upon the high-level "send sms" task.
|
||
|
|
</p>
|
||
|
|
<p>Similary, any other notification category can be implemented. e.g. <code>notify.email.</code>, <code>notify.telegram.</code>, <code>notify.mattermost.</code> etc.
|
||
|
|
</p>
|
||
|
|
<span id="Contents"></span><h3 class="section">1.1 Contents</h3>
|
||
|
|
|
||
|
|
<p>The only implementations so far are three <code>sms</code> notification tasks:
|
||
|
|
</p>
|
||
|
|
<ul>
|
||
|
|
<li> log (as in python logger, thus more or less noop)
|
||
|
|
</li><li> db (postgres)
|
||
|
|
</li><li> Africas Talking API
|
||
|
|
</li></ul>
|
||
|
|
|
||
|
|
<p><strong>NOTE</strong>: The Africas Talking API will be removed from the suite, and provided as an add-on package down the road. It will illustrate how to include arbitrary tasks to a asynchronous group of notification targets.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|