fichub cli

фичуб-кли

CLI для API fichub.net
Чтобы сообщить о проблемах на поддерживаемых сайтах, посетите https://fichub.net/#contact.
Чтобы сообщить о проблемах с CLI, откройте проблему по адресу https://github.com/FicHub/fichub-cli/issues.

Установка

Из пункта (рекомендуется)

 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 , пользователи могут получить всю информацию о файле конфигурации и его настройках.

---

Конфигурация

• Пользователи могут настроить некоторые вещи, такие как db_up_time_format , fic_up_time_format , delete_output_log и filename_format , отредактировав файл config.json в каталоге приложения.

• Параметры формата имени файла (с учетом регистра): author, fichubAuthorId, authorId, chapters, created, fichubId, genres, id, language, rated, fandom, status, updated, title

  Пример:

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

• Вы также можете добавить ключи API в api_key_v0 , который будет включать их в заголовок при вызове API к fichub.

• Чтобы найти файл конфигурации, запустите fichub_cli --config-info , откройте файл config.json в редакторе и внесите необходимые изменения.

Примечания

• Для db_up_time_format и fic_up_time_format :
  • Используйте только допустимые форматы даты и времени.
• Для delete_output_log :
  • По умолчанию пусто, поэтому всегда будет запрашиваться подтверждение.
  • Установите значение "false" чтобы всегда сохранять файл.
  • Установите значение "true" чтобы всегда удалять файл.

Поддержка плагинов

Прочтите вики для получения дополнительной информации.

Вспомогательные сценарии

Вспомогательные скрипты можно найти здесь. Они могут добавлять небольшие функции в CLI без необходимости создания полноценных плагинов.

Ссылки

• Гитхаб вики
• Репозиторий плагинов Github
• Официальный Discord-сервер