Developer’s Guide

Running Locally

Place .env with environment variables to project root, then run:

poetry install
poetry run python run.py

Environment Variables

  • HOLOCAL_YOUTUBE_KEY: Required. API key of YouTube Data API.

  • HOLOCAL_PAGE: Holodule page URL to get. Must be a “シンプル版” (e.g. 全体).

  • HOLOCAL_DIR: Directory to place result .ics files. Default to public.

  • HOLOCAL_LOGLEVEL: Loglevel of logging module. Default to INFO.

Design

The event video URL is output in both the description section and the URL field. At first glance, this may seem redundant, but there is a reason for it. Generally, it is better to use the URL field. This is because if a calendar app does not parse URLs included in the description section, it may become cumbersome to access the link. On the other hand, only including the URL in the field without placing it in the description section can also be problematic, as some calendar apps do not interpret the URL field. One example of this is the web version of Microsoft Outlook.

TODO

  • Type checking

  • Documentation

  • Improve translation

  • Test

References

Adding scripts to your workflow

Workflow syntax for GitHub Actions

pipx - On Linux

Building and testing Python

deploy-pages and Deploy GitHub Pages site.

upload-pages-artifact