todoist-box - Todoistの統計情報をピン留めGistで管理するツール

Tool
todoist-box - Todoistの統計情報をピン留めGistで管理するツール

todoist-box - Todoistの統計情報をピン留めGistで管理するツール

todoist-boxは、Todoistのタスク統計情報をGitHubのピン留めGistに自動的に更新・表示するJavaScript製ツールです。GitHub Actionsと連携し、Todoist APIから取得したデータを使って、日々のタスク達成状況などを視覚的に把握しやすくします。タスク管理の可視化とGitHubプロフィールのカスタマイズを両立できる便利なアクションです。

https://github.com/mayannaoliveira/todoist-box

概要

todoist-boxは、Todoistのタスク統計情報をGitHubのピン留めGistに自動で更新するツールです。GitHub Actionsを利用し、Todoist APIから取得したユーザーのタスク達成状況や統計データをまとめた内容を、指定したGistへ定期的に書き込むことができます。これにより、GitHubプロフィールの情報欄にTodoistの進捗を表示することが可能となり、タスク管理の可視化と開発者の活動アピールを同時に実現します。設定もトークン管理やGistの作成さえ行えば、すぐに運用を開始できるシンプルさが特徴です。

GitHub

リポジトリの統計情報

  • スター数: 1
  • フォーク数: 0
  • ウォッチャー数: 1
  • コミット数: 30
  • ファイル数: 11
  • メインの言語: JavaScript

主な特徴

  • Todoist APIからユーザーのタスク統計データを取得し、GitHub Gistに自動更新
  • GitHub Actions対応でCI/CDの一環として日々のタスク進捗を可視化
  • 利用開始に必要なトークンやGistの事前準備が簡単で導入が容易
  • ピン留めGistを活用し、GitHubプロフィールのカスタマイズが可能

技術的なポイント

todoist-boxはJavaScriptで実装されており、GitHub Actionsと連動して動作することが最大の技術的特徴です。GitHub Actionsのworkflowファイルを用いることで、定期的にまたはイベントトリガーに基づいてTodoist APIにアクセスし、指定したユーザーのタスク統計情報を取得します。このAPI呼び出しには、Todoistの個人アクセストークンを利用し、ユーザーの認証と権限管理を安全に行います。

取得したデータはJSON形式で処理され、必要な統計（例えば、完了したタスク数、未完了タスク、タスクのカテゴリー別集計など）を抽出してMarkdown形式に整形します。このMarkdownはGitHubのGist APIを通じて、指定済みのパブリックGistに書き込まれます。これにより、Gistが最新のTodoistタスク統計ダッシュボードとして機能します。

また、GistはGitHubプロフィール上のピン留め機能により常に目立つ場所に表示できるため、タスク管理の実績を他者に示す手段としても有効です。workflowファイルやaction.ymlによりカスタマイズが可能で、更新頻度や表示内容をユーザーが柔軟に制御できる設計です。

トークン管理にはGitHub Secretsを活用しており、セキュアにAPIキーを扱う仕組みが整っています。さらに、READMEにはセットアップ手順が詳細に記載されており、初心者でも迷わず導入できる点もポイントです。GitHub Actionsの標準機能とTodoist APIを組み合わせた実用的な自動化ツールとして、開発者のワークフローにシームレスに溶け込みます。

プロジェクトの構成

主要なファイルとディレクトリ：

  • .github: GitHub Actionsのworkflow定義を含むディレクトリ
  • .gitignore: Git管理対象外ファイルの指定
  • LICENSE: ライセンス情報
  • README.md: プロジェクト概要とセットアップ手順説明
  • action.yml: GitHub Actionのメタデータ定義
  • その他JavaScriptソースファイル（API呼び出しやMarkdown生成ロジック）

まとめ

GitHub ActionsとTodoistを連携し、タスク統計をGitHubプロフィールに反映できる便利なツール。

リポジトリ情報：