Endid Python和命令行客户端

注意：由于Endid.app服务现已成为GitHub / Slack的原生集成，因此此软件包实际上已归档！请参阅Endid.app以获取最新详情。

命令行工具和Python客户端，用于调用Endid Slack应用以宣布任务已完成！

Endid.app是一个更简单、更灵活的webhook - 开发人员和数据科学家的非正式Slack集成。

你发现自己不断检查终端、笔记本或Web应用，等待查看你的开发任务是否完成吗？

Endid为任何Slack频道提供一个唯一的令牌。你可以使用Endid的简单API或命令行工具来通知你任何进程何时完成。

你可以在Slack中直接暂时静音通知。

安装

要安装Python和命令行客户端

pip install endid

endid将不会安装任何其他依赖项。

用法

两个客户端都将在您的系统上存储最后一次使用的令牌和消息，因此随后调用没有任何令牌的简单客户端仍然可以到达Slack。

一旦Endid在Slack中安装，请转到任何频道（或带有Endid应用机器人的消息历史记录）并输入/endid。您将收到一个类似于7c710a188f874520be1f7ab7815c6cd1的令牌，您将使用下面的示例。

命令行

将令牌作为参数提供，以便在Slack频道中显示简单的消息（“您的任务已完成！”）

endid -t 7c710a188f874520be1f7ab7815c6cd1

下次，只需调用endid即可重用相同的令牌和Slack频道

endid

为（已保存的）频道/令牌提供自定义消息

endid -t 7c710a188f874520be1f7ab7815c6cd1 -m 'Here is a message'

要获取更多命令行选项，请运行endid -h

从Python代码

从您的Python代码中，例如在Jupyter笔记本中

import endid
endid.call(token='7c710a188f874520be1f7ab7815c6cd1')

使用上次相同的令牌（无论来自Python还是命令行）

import endid
endid.call()

额外参数

message - 要在Slack频道中显示的自定义消息。

status - 事件状态 OK | WARN | FAIL | NONE。

name - 任何字符串，用作事件源的标识符。

writeprefs - 是否将令牌/消息写入首选项文件，以便它们下次成为默认值（默认=True）

readprefs - 是否从首选项文件读取令牌/消息（默认=True）

printoutput - 是否将任何成功或错误消息打印到屏幕（默认=False）

调用函数在一切顺利时返回API的OK响应，如果不顺利则返回错误消息。

GitHub Actions

我们有一个现成的 GitHub Action，可以轻松通过Endid发送Slack消息。

最好的是，可以直接从Slack频道中禁用通知，或者避免在开发工作流程时打扰同事。

安装故障排除

安装说明假设您系统上已安装 pip。这通常是现代Windows和Mac的情况。如果没有，您可以首先 安装pip。

或者，下载 此文件，将其重命名为 endid 并将其放置在路径中的某个位置。还要使其可执行。

如果您正在使用virtualenvs进行Python开发，则pip install endid可能会尝试在您的活动virtualenv中安装它，只要virtualenv处于活动状态，它就可以正常工作。要“全局”安装，首先deactivate virtualenv。如果您收到有关pip“找不到激活的virtualenv”的投诉，请首先设置环境变量PIP_REQUIRE_VIRTUALENV=false。

请随时在此存储库中提出 GitHub Issue，或联系 support@endid.app，以解决系统上的安装或使用问题。