hato-bot

by nakkaa

GitHub Readme.md

鳩bot - 愛嬌のあるSlack Bot

badge Dependabot Status

Deploy

鳩botではこんなことができます。

  • 全国の天気予報 ... 天気 東京 で東京の天気予報を表示します。
  • 東京近郊の雨雲情報 ... amesh で東京の雨雲情報を画像で表示します。
  • 最新の地震情報 ... eq で最新の地震情報を3件表示します。
  • パワーワードの登録、表示 ... text で登録したパワーワードを表示します。
  • 突然の死吹き出しで整形 ... >< 文字列 で文字列を「突然の死」吹き出しで整形します。

hato

鳩botを動かす

鳩botを動かす方法は主に2種類あります。
簡単でおすすめなHerokuで動かす方法と自分のPC上で動かす方法です。
前者については、 Herokuで動かす手順 を参照してください。
ここでは後者の自分のPC上で動かす方法を説明します。

必要なもの

以下が必要です。

初期設定

  1. このリポジトリをcloneします。

    git clone git@github.com:nakkaa/hato-bot.git
    cd hato-bot
  2. Pipenvで仮想環境を作成します。

    pipenv install
  3. .env ファイルを作成し Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenを記述します。

    SLACKBOT_API_TOKEN=xoxb_xxxxxxxxx
    DATABASE_URL=postgres://postgres:password@localhost:5432/
    YAHOO_API_TOKEN=xxxxxxxxx
    
  4. PostgreSQLを起動します。(Dockerの場合は以下のコマンドを実行します。)

    cd ./setup
    docker-compose up -d
    cd ..
  5. pipenv run python ./run.py を実行します。

補足

  • コードをformatする場合は pipenv run autopep8 --in-place --recursive . を実行します。

クレジット

Botで利用しているサービスのクレジットを記載します。