チュートリアルの進行時のストーリを用意する

hrsano645 commented 4 years ago

チュートリアルの進行時のストーリを用意する。参加者が作業をするタイミングやスライドの大雑把な方向になる。

とある会社内でslackを使っていて
slackbotで日頃やることをbotにやらせたくなる。チャットボットを気軽に作ろう
挨拶bot候補1:世界の挨拶を返すgreetingbotを導入として扱う: 例えば多国籍な社内なら、その方向けに挨拶をしたい→挨拶のワードを忘れるから毎回聞きたくなる->毎回挨拶をランダムにかえしてくれるbotを実装して気軽に聞こう
- slackbotの最初の作り方
- 挨拶を返してくれる
- 次に世界の挨拶を返せるようにする -> ランダムに挨拶を返そう
- 最後に挨拶を返す部分をPyhtonのモジュールとして分離させる:（この時点で、メッセージのやり取りは共通の関数を使い、各botはモジュール（1ファイルだけど）として分けている）
オンラインイベントを探して勉強会に気軽に行けるようにする -> connpassでイベント検索できるconnpassbot
- connpass apiの仕様
- 今回はオンライン, pythonの検索ワードは固定
- APIとのやり取りの分離をしておこう。: 結果を作る関数と、APIレスポンスを受け取る関数を分ける。
リモートワークが当たり前になってきている中で、いろんな地域の天気を聞きたくなる -> tenkibot
- 参考程度の説明になる
- 気象庁のXMLの対応方法
- 地域検索ワードを好きなものを追加してみる
こうしてbotが完成して動くようになった！
- しかしメンテはやはりやらないといけない
- 他の方もbotを書きたい！
botのインターフェイスはあるので、それをテストして安全にbotの機能を追加しよう
- pytestで現在までに作ったbotのテストを用意してみる
- pytestの実行方法: -v,
- 挨拶bot, connpassbot: fixture, monkeypatch
- 天気bot: fixture, monkeypatch, parametarize
テストもかけるようになって安心
- しかしそもそもこの中身説明できる？
- ドキュメントの必要性: メンテし続ける上では必要になる。新しく使いたい人がショートカットできるように用意しよう
- 既存のbot修正でも無いと誰もわからなくなる。
docstringをかく
- botの共通で使うメッセージハンドル関数
- 各bot
sphinxでかんたんにドキュメントをかく
- まずはbotの使い方を用意してみる
- ？（botの書き方も用意する）
- sphinxのautodocで各botのドキュメントを用意する（

hrsano645 commented 4 years ago

挨拶botの導入が微妙。挨拶のワードを忘れる=こんにちは英語 みたいに聞くことになると思う。それがbotとして役立つものかがわからない

（似たようなbotの実装例をどこかで見かけたけど、同じようなことになってしまうし、別の案が欲しい）

hrsano645 commented 4 years ago

こんにちは！と打ったら、ランダムでいろんな国の言葉が返ってくると面白いのでは？

hrsano645 commented 4 years ago

挨拶botの内容をランダムで言葉を返す実装に変更

このストーリーを元に、 #5 を更新して、tutorial_docsを作成する

py-suruga / pycon-jp-2020-tutorial

チュートリアルの進行時のストーリを用意する #11