fichub cli

フィチュブクリ

fichub.net API の CLI
サポートされているサイトの上流で問題を報告するには、https://fichub.net/#contact にアクセスしてください。
CLI の問題を報告するには、https://github.com/FicHub/fichub-cli/issues で問題を開きます。

インストール

pip から (推奨)

 pip install -U fichub-cli

Github ソースより (プレリリース、ベータ テスターに​​よる新機能のテスト用)

 pip install git+https://github.com/FicHub/fichub-cli@main

使用法

 > fichub_cli
Usage: fichub_cli [OPTIONS] COMMAND [ARGS]...

  A CLI for the fichub.net API

  To report issues upstream for supported sites, visit
  https://fichub.net/#contact

  To report issues for the CLI, open an issue at
  https://github.com/FicHub/fichub-cli/issues

  Failed downloads will be saved in the `err.log` file in the current
  directory

Options:
  -u, --url TEXT          The url of the fanfiction enclosed within quotes
  -i, --infile TEXT       Path to a file to read URLs from
  -l, --list-url TEXT     Enter a comma separated list of urls to download,
                          enclosed within quotes
  -v, --verbose           Show fic stats
  -o,  --out-dir TEXT     Path to the Output directory for files (default:
                          Current Directory)
  --format TEXT           Download Formats, comma separated if multiple: epub (default), mobi, pdf or html
  --force                 Force overwrite of an existing file
  -ss, --supported-sites  List of supported sites
  -d,  --debug            Show the log in the console for debugging
  --changelog             Save the changelog file
  --debug-log             Save the logfile for debugging
  --config-init           Initialize the CLI config files
  --config-info           Show the CLI config info
  --version               Display version & quit
  --help                  Show this message and exit.

デフォルト設定

• ファンフィクションは epub 形式でダウンロードされます。変更するには、 --formatを使用します。カンマで区切って複数の形式を選択できます。
• ファンフィクションは現在のディレクトリにダウンロードされます。変更するには、 -oの後にディレクトリへのパスを指定します。
• 失敗したダウンロードは、現在のディレクトリのerr.logファイルに保存されます。

詳細については、 fichub_cli --helpを確認してください。

例

• URLを使用してダウンロードするには

 fichub_cli -u https://archiveofourown.org/works/10916730/chapters/24276864

• URLを含むファイルを使用してダウンロードするには

 fichub_cli -i urls.txt

• カンマ区切りの URL リストを使用してダウンロードするには

 fichub_cli -l "https://www.fanfiction.net/s/11191235/1/Harry-Potter-and-the-Prince-of-Slytherin,https://www.fanfiction.net/s/13720575/1/A-Cadmean-Victory-Remastered"

• 複数の形式をダウンロードするには

 fichub_cli -u "https://www.fanfiction.net/s/13720575/1/A-Cadmean-Victory-Remastered" --format epub,mobi

• ダウンロードの変更ログを生成するには

 fichub_cli -i urls.txt --changelog

---

注記

• --out-dirまたは-o 、上記のすべてのコマンドで出力ディレクトリを選択するために使用できます。

• --config-initフラグを使用すると、ユーザーは構成ファイルをデフォルトに再初期化/上書きできます。

• --config-infoフラグを使用すると、ユーザーは構成ファイルとその設定に関するすべての情報を取得できます。

---

構成

• ユーザーは、アプリ ディレクトリ内のconfig.jsonファイルを編集することで、 db_up_time_format 、 fic_up_time_format 、 delete_output_log 、 filename_formatなどの項目を構成できます。

• ファイル名形式の小道具 (大文字と小文字を区別): author, fichubAuthorId, authorId, chapters, created, fichubId, genres, id, language, rated, fandom, status, updated, title

  例：

   "filename_format": "[title] by [author]"
  

• API キーをapi_key_v0に追加して、fichub への API 呼び出しを行うときにヘッダーに含めることもできます。

• 構成ファイルを見つけるには、 fichub_cli --config-infoを実行し、エディターでconfig.jsonファイルを開いて必要な変更を加えます。

注意事項

• db_up_time_formatおよびfic_up_time_formatの場合:
  • 有効な日時形式のみを使用してください
• delete_output_logの場合:
  • デフォルトは空白なので、常に確認を求めるプロンプトが表示されます
  • ファイルを常に保持するには"false"に設定します。
  • 常にファイルを削除するには、 "true"に設定します。

プラグインのサポート

詳細については wiki を読んでください。

ヘルパースクリプト

ヘルパー スクリプトはここにあります。本格的なプラグインを作成しなくても、CLI に小さな機能を追加できます。

リンク

• Github ウィキ
• Github プラグイン リポジトリ
• 公式Discordサーバー