跳转到主要内容

在Slack上自动标记您的A.F.K.(远离键盘)状态

项目描述

https://img.shields.io/pypi/v/afk_slack_agent.svg

自动在Slack上标记您的A.F.K.(远离键盘)状态。

安装

pip install afk_slack_agent

它做什么?

此软件附带代理(afk_agent)和客户端(afk,可选)。

代理设计为在后台运行并保持活跃,直到您终止它。

代理实现的功能

  • 等待锁定屏幕和解锁屏幕事件

  • 连接到Slack工作区,并在锁定时更改用户状态(解锁时清除)

  • 可选:锁定/解锁时在频道上写消息

先决条件

  • 您需要创建Slack应用程序并将其安装到您的工区 - 该应用程序应至少有以下权限:users.profile:write。

    可选,您还可以启用chat:write和reactions:write

  • 要从客户端运行自定义AFK命令,您需要启用代理以控制您的Mac(从“隐私和安全”系统设置)

配置

第一次运行代理时,将创建一个~/.afk.json文件。

这是默认创建的文件

{
  "version": 1,
  "token": "",
  "status_text": "I need a break",
  "status_emoji": ":coffee:",
  "channel": null,
  "away_message": "I'm going to take a coffee break",
  "back_message": "I'm back",
  "delay_for_reaction_emoji": 60,
  "back_emoji": "back",
  "agent_emoji": "robot_face",
  "agent_active_start_time": null,
  "agent_active_end_time": null,
  "actions": [
    {
      "action": "lunch",
      "status_text": "Lunch break",
      "status_emoji": ":spaghetti:",
      "away_message": "I'm going to take the lunch break",
      "back_message": "I'm back and stuffed!",
      "command": "lock"
    }
  ]
}

最重要的键是 token,它必须包含 Slack 用户 OAuth Token。

Slack configuration, where to grab your token

其他设置

status_text

锁定屏幕时设置的状态

status_emoji

锁定屏幕时设置的表情

channel

如果你想在不在线时在频道上发消息,再回来,请使用此选项。

将频道 ID 放在那里。您可以通过在频道上右键单击并单击“查看频道详细信息”来找到它。它将在弹出窗口的底部。

away_message

离线时发送的消息

back_message

返回键盘时发送的消息

delay_for_reaction_emoji

如果您将在这么多秒内回来,不要发送返回消息,而是只需使用反应表情对您的离线消息进行反应。这将减少快速锁定/解锁屏幕时的噪音。

back_emoji

快速返回反应使用的表情

agent_emoji

自动在每条发送的消息或设置的 Slack 状态末尾添加此表情。这有助于其他人知道有机器人正在为您操作。

delay_after_screen_lock

在开始与 Slack 互动之前,等待这么多秒。

这将延迟对您的锁定屏幕状态的反应,因此如果您在这段时间内解锁屏幕,则不会运行任何 Slack 命令。例如:您正在阅读文档,屏幕因不活动而锁定,但您并不是真的离线。

agent_active_start_timeagent_active_end_time

代理有效工作的时间范围。

当提供(格式为 HH:MM)时,代理只有在当前时间位于此(可能开放的)时间范围内时才会有效工作。这可以用来在工作时间外禁用代理。

此设置不应用于显式操作(afk <command>)。

自定义操作

JSON 配置可以包含一个 actions 键,其中包含自定义操作的数组。

可以使用客户端组件将自定义操作发送到代理

afk lunch

自定义操作是一种执行比标准锁定/解锁监视器更多的操作的方法。

有关更多信息,请参阅 afk 命令行帮助。

操作与代理以相同的方式与 Slack 交互,并继承相同的配置,但可以覆盖其中一些,例如:status_textstatus_emojiaway_messageback_message。每个设置都可以是 null 以显式继承全局设置。back_message 还可以是 false:即使全局设置有值,也会禁用此操作的返回消息。

最后,自定义操作可以执行以下命令之一

lock

手动锁定屏幕

sleep

将您的计算机置于睡眠状态

为什么?

要了解此工具的动机,请阅读 为什么我需要将锁定屏幕活动与 Slack 结合起来

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解有关 安装软件包 的更多信息。

源分布

afk_slack_agent-0.2.0.tar.gz (53.6 kB 查看哈希值

上传于 源代码

构建版本

afk_slack_agent-0.2.0-py2.py3-none-any.whl (11.7 kB 查看哈希值)

上传于 Python 2 Python 3

由以下支持