開発の手引き

ローカルで実行

プロジェクトルートに.envファイルを置き、環境変数を設定してください。 その後、以下を実行します。

poetry install
poetry run python run.py

環境変数

  • HOLOCAL_YOUTUBE_KEY: 必須です。YouTube Data APIのAPIキーです。

  • HOLOCAL_PAGE: 取得するホロジュールのページのURLです。「シンプル版」でなければなりません(例:全体)。

  • HOLOCAL_DIR: 結果のicsファイルを置くディレクトリです。既定はpublicです。

  • HOLOCAL_LOGLEVEL: loggingモジュールのログ水準です。既定でINFOです。

設計

イベントの動画のURLは、説明欄とURLフィールドの両方に出力しています。 一見すると重複しているようですが、これには理由があります。 基本的に、URLのフィールドは利用した方が良いです。 これは、もしカレンダーアプリが説明欄に含まれるURLを解析しない仕様のとき、リンクの遷移に手間が掛かる可能性があるためです。 一方で、URLのフィールドのみで、説明欄にURLが含まれていない場合も問題があります。 カレンダーアプリの中には、URLのフィールドを解釈しないものがあるためです。 一例ではMicrosoft Outlookのウェブ版がこれに該当します。

TODO

  • 型検査

  • ドキュメント

  • 翻訳を改善

  • テスト

参考資料

ワークフローにスクリプトを追加する

GitHub Actions のワークフロー構文

pipx - On Linux

Python のビルドとテスト

deploy-pages and Deploy GitHub Pages site.

upload-pages-artifact