Téléchargement fichub cli - Téléchargement du code source fichub cli

fichub cli

Autre code source

v0.10.2

Télécharger

fichub-cli

Une CLI pour l'API fichub.net
Pour signaler les problèmes en amont pour les sites pris en charge, visitez https://fichub.net/#contact
Pour signaler des problèmes pour la CLI, ouvrez un problème sur https://github.com/FicHub/fichub-cli/issues

Installation

De pip (recommandé)

 pip install -U fichub-cli

Depuis Github Source (pré-version, pour tester les nouvelles fonctionnalités par les bêta-testeurs)

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

Usage

 > 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.

Configuration par défaut

La fanfiction sera téléchargée au format epub. Pour le modifier, utilisez --format suivi du format. Plusieurs formats peuvent être sélectionnés en les séparant par des virgules.
La fanfiction sera téléchargée dans le répertoire courant. Pour le modifier, utilisez -o suivi du chemin d'accès au répertoire.
Les téléchargements ayant échoué seront enregistrés dans le fichier err.log du répertoire actuel.

Vérifiez fichub_cli --help pour plus d'informations.

Exemple

Pour télécharger à l'aide d'une URL

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

Pour télécharger à l'aide d'un fichier contenant des URL

 fichub_cli -i urls.txt

Pour télécharger à l'aide d'une liste d'URL séparées par des virgules

 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"

Pour télécharger plusieurs formats

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

Pour générer un journal des modifications du téléchargement

 fichub_cli -i urls.txt --changelog

NOTE

--out-dir ou -o peut être utilisé dans toutes les commandes ci-dessus pour sélectionner un répertoire de sortie.
À l'aide de l'indicateur --config-init , les utilisateurs peuvent réinitialiser/écraser les fichiers de configuration par défaut.
En utilisant l'indicateur --config-info , les utilisateurs peuvent obtenir toutes les informations sur le fichier de configuration et ses paramètres.

Configuration

Les utilisateurs peuvent configurer certains éléments comme db_up_time_format , fic_up_time_format , delete_output_log et filename_format en éditant le fichier config.json dans le répertoire de l'application.
Accessoires de format de nom de fichier (sensibles à la casse) : author, fichubAuthorId, authorId, chapters, created, fichubId, genres, id, language, rated, fandom, status, updated, title
Exemple:
```
 "filename_format": "[title] by [author]"
```
Vous pouvez également ajouter des clés API à api_key_v0 qui l'incluront dans l'en-tête lors des appels API à fichub
Pour localiser le fichier de configuration, exécutez fichub_cli --config-info et ouvrez le fichier config.json dans un éditeur et apportez les modifications nécessaires.

Remarques

Pour db_up_time_format & fic_up_time_format :
- Utilisez uniquement des formats datetime valides
Pour delete_output_log :
- La valeur par défaut est vide, donc une confirmation sera toujours demandée
- Réglez-le sur "false" pour toujours conserver le fichier
- Réglez-le sur "true" pour toujours supprimer le fichier

Prise en charge des plugins

Lisez le wiki pour plus d'informations.

Scripts d'aide

Les scripts d'assistance peuvent être trouvés ici. Ils peuvent ajouter de petites fonctionnalités à la CLI sans avoir besoin de créer des plugins à part entière.