alertist

Alertist是一个库，它使向目标发送消息变得尽可能简单，无需重写代码。所有配置都通过环境变量完成。

动机

发送警报只需简单。代码不需要重写以更改消息的目标，部署不需要发生，CI只需发送电子邮件，而SNS消息即可。这就是alertist的用武之地。

Alertist使发送警报变得简单。配置环境变量，然后运行您的Python应用程序。但也许这不符合您的需求 - alertist默认从当前工作目录加载.env，使触发警报发送尽可能无痛，而不产生应用程序开销。

安装

pip安装alertist

用法

创建一个alertist对象，并使用目标和方法调用alert。alertist对象必须使用您要发送的目标或警报类型实例化。

from alertist import Alertist
from alertist.targets import Pushover

a = Alertist(Pushover)
a.alert("Hello, world!")

如果您想异步发送消息，您将使用完全相同的代码，只是现在调用alert方法变为aalert，并且必须等待。

from alertist import Alertist
from alertist.targets import Pushover

a = Alertist(Pushover)
await a.alert("Hello, world!")

支持的警报类型可以在targets文件夹中找到。

贡献

编写新的警报目标

错误、功能或集成？请随时以任何方式贡献！但以下我们将重点介绍如何创建新的警报目标。

1. 创建一个新的类，继承自ABCTarget
2. 实现同步的alert方法和异步的aalert方法
3. 将所有可配置的环境变量添加到您类中的CONFIG_KEYS
4. 将您的类添加到targets.__all__中的__init__.py
5. 编写两个单元测试，可能需要模拟连接。