happeninghound

README

HappeningHound

HappeningHoundは、Slackでの特定のユーザーの投稿を自動的に記録し、後から振り返ることができるボットです。 ボットを招待したチャンネルに投稿された内容をJSON形式で保存します。

説明

チームのコミュニケーションを記録し、後から参照できるようにすることは重要です。 しかし、手動で記録を取ることは手間がかかり、ミスが発生する可能性があります。 HappeningHoundを使えば、Slackでのやり取りを自動的に記録できるので、安心して大切な情報を失うことなく、後から振り返ることができます。

機能

• Slackのボットがいる公開チャンネルに特定のユーザー（author_id）から投稿された内容を監視し、記録します。
• メッセージ本文、投稿時刻、添付ファイル(画像など)をJSON形式で保存します（images/<チャンネル名>/ファイル名で添付ファイルを保存）。
• 保存先はローカルの<チャンネル名>.jsonlファイルです（すでにファイルが存在する場合は追記され、存在しない場合は作成します）。
• 保存・追記されたファイルはGoogle Drive APIを利用してGoogle Driveにも保存されます。
  • ディレクトリ構造はローカルのものと同等です。
  • happeninghound、happeninghound/images、happeninghound/htmlというディレクトリをあらかじめ作成しておく必要があります。
  • ファイルは上書き扱いになります。
• /make-htmlというスラッシュコマンドでこれまで保存されているデータからHTMLファイルを生成します。
  • html/<チャンネル名>.htmlというファイルで作成します。
  • config/templateにあるhtmlファイルがテンプレートです。cssは利用するだけです。
  • 起動時にhtml/output.cssにファイルをコピーします（コピーに失敗したら起動に失敗します）
  • Google Driveにはhtmlだけがアップロードされます。
    • cssファイルは手動でアップロードする必要があります。

使い方

1. Botをインストールし、Slackワークスペースに追加します。
2. Botをチャンネルに招待します(招待されたら「Start recording...」とメッセージが飛んできます)。
3. ボットのいるチャンネルにメッセージを投稿すると、その内容がJSON形式で記録ファイルに自動的に追記されます（このタイミングでGoogle Driveにも保存・追記）。
4. チャンネルで/make-htmlコマンドを実行すると、これまでの内容をもとにHTMLを生成します。

設定

設定ファイル(config/config.json)で以下の項目を設定できます。

• bot_token: Slack APIのBotトークン
• app_token: Slack APIのAppトークン
• debug: Slackクライアントのデバッグ(true/false)
• basedir: 保存するファイルのローカルディレクトリ
• author_id: 記録するユーザーID

Google Drive APIのためのクレデンシャルファイルをconfig/credentials.jsonという名前で配置します。 Google Driveにデータ保存する機能のためには、「happeninghound/images」というフォルダを事前に作成しておく必要があります。

ライセンス

• MITライセンスの元でリリースされています。詳細はLICENSEファイルを参照してください。