kot

概要

以下の機能が CLI で操作できる

KING OF TIME の勤怠データから勤務時間の貯金時間等を計算する
My レコーダーで打刻する

実行環境の準備

$ git clone https://github.com/takaiyuk/kot.git
$ cd kot
$ mkdir ~/.kot
# config.yaml を適宜書き換える
$ cp ./config.yaml.example ~/.kot/config.yaml
$ poetry install
$ poetry run invoke build

NOTE

ローカルでの実行は Arm64 の MacOS のみサポートしている

Scrape KOT

Slack に通知

$ poetry run invoke scrapekot-slack

出力イメージ

Console に通知

Slack チャンネルに通知させたくない場合は実行のコンソール上のみに出力させることも可能

$ poetry run invoke scrapekot

出力イメージ

    残り12営業日: (8.0/20.0 日)

    あと94時間34分必要: (65時間26分/160時間)

    貯金: 1時間26分

    貯金を元に残り営業日の必要勤務時間数を算出すると: 7時間52分

    2019-11-14の出勤・定時
        出勤: 10:15
        定時: 19:15

AWS Lambda で実行 (scrapekot)

AWS Lambda で動かすためにコンテナイメージを利用して Lambda 関数コードをデプロイすることができる（ref. コンテナイメージで Python Lambda 関数をデプロイする）

.env で定義したイメージレポジトリをあらかじめ作成しておく必要がある

# .env を適宜書き換える
$ cp scripts/docker/lambda/.env.example scripts/docker/lambda/.env
$ ./scripts/docker/lambda/build.sh
$ ./scripts/docker/lambda/push.sh

NOTE: AWS Lambda で環境変数の設定が必要

CLI で以下のようにして例えば kot という名前の関数に環境変数を設定できる

$ aws lambda update-function-configuration --function-name kot \
    --environment "Variables={ACCOUNT_ID=id,ACCOUNT_PAWSSWORD=password,MYRECORDER_SLACK_WEBHOOK_URL=webhook_url,MYRECORDER_SLACK_CHANNEL=channel,MYRECORDER_SLACK_ICON_EMOJI=icon_emoji,MYRECORDER_SLACK_USERNAME=usename,SCRAPEKOT_SLACK_WEBHOOK_URL=webhook_url,SCRAPEKOT_SLACK_CHANNEL=channel,SCRAPEKOT_SLACK_ICON_EMOJI=icon_emoji,SCRAPEKOT_SLACK_USERNAME=usename}"

以下のコマンドで現在の設定を取得できる

$ aws lambda get-function-configuration --function-name kot

以下のコマンドで実行できる

$ aws lambda invoke --function-name kot --cli-binary-format raw-in-base64-out --payload '{ "command": "scrape" }' /dev/stdout

My Recorder

利用可能なオプションは以下の通り

start: 出勤
end: 退勤
rest_start: 休憩開始
rest_end: 休憩終了

実行例

出勤

$ poetry run invoke myrecorder-start

退勤

$ poetry run invoke myrecorder-end

休憩開始

$ poetry run invoke myrecorder-start-rest

休憩終了

$ poetry run invoke myrecorder-end-rest

AWS Lambda で実行 (myrecorder)

myrecorder_command で上記のオプションを指定する

$ aws lambda invoke --function-name kot --cli-binary-format raw-in-base64-out --payload '{ "command": "myrecorder", "myrecorder_command": "start" }' /dev/stdout

Development

Setup

$ poetry install

Lint

$ poetry run invoke lint

Test

$ poetry run invoke test

Invoke tasks

$ poetry run inv --list
Available tasks:

  build                   Build docker compose
  lint                    Lint
  myrecorder-end          Run MyRecorder to end working
  myrecorder-end-rest     Run MyRecorder to end rest
  myrecorder-start        Run MyRecorder to start working
  myrecorder-start-rest   Run MyRecorder to start rest
  pydeps                  Create pydeps graph
  scrapekot               Run scrapekot to notify on console
  scrapekot-slack         Run scrapekot to notify on slack
  test                    Test

Typer Help

$ poetry run python -m kot --help
Usage: python -m kot [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  initialize  Get cache of the latest chromedriver version for chromium...
  myrecorder
  scrape

$ poetry run python -m kot scrape --help
Usage: python -m kot scrape [OPTIONS]

Options:
  --console / --no-console        [default: console]
  --amazon-linux / --no-amazon-linux
                                  [default: no-amazon-linux]
  --browser-kind [chrome|chromium|firefox|remote]
                                  [default: BrowserKind.chrome]
  --headless / --no-headless      [default: headless]
  --help                          Show this message and exit.

$ poetry run python -m kot myrecorder --help
Usage: python -m kot myrecorder [OPTIONS] COMMAND

Arguments:
  COMMAND  [required]

Options:
  --yes / --no-yes                [default: no-yes]
  --message TEXT
  --debug / --no-debug            [default: no-debug]
  --amazon-linux / --no-amazon-linux
                                  [default: no-amazon-linux]
  --browser-kind [chrome|chromium|firefox|remote]
                                  [default: BrowserKind.chrome]
  --headless / --no-headless      [default: headless]
  --help                          Show this message and exit.

Pydeps

$ poetry run invoke pydeps

Dependency Visualization

mocyuto / kot

kot

TOC

概要