dogsheep / dogsheep/github-to-sqlite

feature: display progress bar when downloading multi-page responses

オープン
#72 コメント 1 件 リアクション 3 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
474
フォーク
50
PR マージ指標
30日以内にマージされた PR はありません

説明

## Motivation

For a long running command (longer than 1 minute) for a big table (like pull requests or commits), it can be tricky to know if the script is still running, or if a rate limit/error was encountered

We know how many pages there are, so it may be possible to indicate how many remain.

https://github.com/dogsheep/github-to-sqlite/blob/a6e237f75a4b86963d91dcb5c9582e3a1b3349d6/github_to_sqlite/utils.py#L367

## Resources

- Using the existing Click API:
- https://click.palletsprojects.com/en/5.x/utils/#showing-progress-bars
- Loading spinner: https://github.com/pavdmyt/yaspin
- Progress bar: https://github.com/tqdm/tqdm

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

複数ページのレスポンスがダウンロードされる github_to_sqlite/utils.py の367行目付近から始めてください。まず、既存のページネーションのフローと、リンクされている Click のプログレスバーに関するガイダンスを確認してください。長時間実行される複数ページのダウンロードで進捗が見えるように表示され、残りページ数を取得できる場合にはその数も表示されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github, python
領域
api, cli
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。