afk-slack-agent 0.3.0

Installation

pip install afk_slack_agent

What it does?

This software is distributed with an agent (afk_agent) and a client (afk, optional).

The agent is designed to be run in the background and stay active until you terminate it.

Features implemented by the agent

• waits for lock screen and unlock screen events (very buggy feature, due to changes in behavior in every MacOS release 😮‍💨)

• connects to a Slack workspace, and change user status on lock (clean it on unlock)

• optionally: write a message on a channel on lock/unlock

Prerequisites

• you have to create a Slack application, and install it into your workspace - the application should have at least the following scope: users.profile:write.

  optionally, you could also enable chat:write and reactions:write

• to run custom AFK commands from the client, you’ll need to enable the agent to control your Mac (from “Privacy and Security” system settings)

How to use

Run afk --help for a list of all commands.

In brief: when the agent is running, you can run afk <action> to interact with slack.

Actions must be customized in you .afk file (see below), apart for:

• terminate - kill the agent

• back- signal Slack you are BTK

Configuration

The first time the agent is run, a ~/.afk.json file is created.

This is the default file created:

{
  "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"
    }
  ]
}

The most important key is token, which must contain the Slack User OAuth Token.

afk lunch

Why?

To understand motivation about this tool, read why I needed to join my lock screen activities with Slack.