うーたんbot

1. 用途

　岐阜市のぎふ長良川鵜飼のマスコットキャラクター、
うーたんとその家族とのおしゃべりを楽しむCODE for Gifu内限定のチャットBotです。

岐阜市のうーたん紹介ページ

2. 動作環境

Webサーバー環境

Heroku: u-tan-bot
言語：Python

Heroku App スリープ解除Bot

Herokuのフリープランでホストする場合、30分毎にAppがスリープ状態になる。
うーたんBotの動作の妨げになるため、 @tetsuji1122氏の個人アカウントから、UptimeRobotを設定している。

ユーザー環境

Slack: CODE for Gifu

3. 開発環境

3-1. ローカル環境 構築手順

1. Pythonインストール
   バージョンは、runtime.txtと合わせる。

2. 仮想環境の作成(任意)
   ・Windows

   cd workspace
   py -3.8 -m venv venv 
   .\venv\Script\activate

   ・Linux

   cd workspace
   python3 -m venv venv
   source ./venv/bin/activate

3. pipパッケージのインストール

   pip3 install -r requirements.txt

3-2. 読みやすいコードのために

Python Linter/Formatter

pysen

requirements.txtにpysenを含めています。 以下のコマンドで誰でも簡単にpythonコードファイル(*.py)の整形ができます。

pysen run format

設定内容は、pyproject.tomlで確認できます。

3-3. デプロイ

当リポジトリのmainブランチを、herokuのAutoDeployに設定しています。
mainブランチへのcommitは、本番環境に即時展開されます。
herokuでの環境構築後の起動については、Procfileに記載があります。