fichub-cli-metadata
A metadata plugin for fetching Metadata from the Fichub API for fichub-cli
To report issues upstream for the supported sites, visit https://fichub.net/#contact
To report issues for the plugin, open an issue at https://github.com/fichub-cli-contrib/fichub-cli-metadata/issues
To report issues for the CLI, open an issue at https://github.com/FicHub/fichub-cli/issues
Installation
From pip (Stable, recommended)
pip install -U fichub-cli-metadata
From Github Source (Pre-release, for testing new features by Beta testers)
pip install git+https://github.com/fichub-cli-contrib/fichub-cli-metadata@main
Usage
> fichub_cli metadata
Usage: fichub_cli metadata [OPTIONS] COMMAND [ARGS]...
A metadata plugin for fetching Metadata from the Fichub API for fichub-cli
To report issues upstream for the supported sites, visit
https://fichub.net/#contact
To report issues for the plugin, open an issue at https://github.com/fichub-
cli-contrib/fichub-cli-metadata/issues
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:
-i, --input TEXT Input: Either an URL or path to a file
--input-db TEXT Use an existing sqlite db
--update-db Self-Update existing db (--input-db required)
--export-db Export the existing db as json (--input-db required)
-o, --out-dir TEXT Path to the Output directory (default: Current
Directory)
--download-ebook TEXT Download the ebook as well. Specify the format: epub
(default), mobi, pdf or html
--fetch-urls TEXT Fetch all story urls found from a page. Currently
supports archiveofourown.org only
-v, --verbose Show fic stats
--force Force update the metadata
-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.
Default Configuration
- The fanfiction will be downloaded in the current directory. To change it, use
-ofollowed by the path to the directory. - Failed downloads will be saved in the
err.logfile in the current directory.
Check fichub_cli metadata --help for more info.
Example
- To fetch metadata using an URL
fichub_cli metadata -i https://archiveofourown.org/works/10916730/chapters/24276864
- To fetch metadata using a file containing URLs
fichub_cli metadata -i urls.txt
- To choose a output directory
fichub_cli metadata -i urls.txt -o "~/Desktop/books"
- To save the metadata in an existing db
fichub_cli metadata -i urls.txt --input-db "urls - 2022-01-29 T000558.sqlite"
- To update an existing db from given input
fichub_cli metadata -i urls.txt --input-db "urls - 2022-01-29 T000558.sqlite" --force
- To self-update an existing db i.e. update each row from the db
fichub_cli metadata --input-db "urls - 2022-01-29 T000558.sqlite" --update-db
- To dump an existing db as a json
fichub_cli metadata --input-db "urls - 2022-01-29 T000558.sqlite" --export-db
- To download the ebook along with the metadata
fichub_cli metadata -i urls.txt --download-ebook epub,mobi
- To get all story urls found from a page. Currently supports archiveofourown.org only.
fichub_cli metadata --fetch-urls https://archiveofourown.org/users/flamethrower/
- To generate a changelog of the download
fichub_cli metadata -i urls.txt --changelog
NOTE
-
If there are any database schema changes, the CLI will automatically migrate the db. A
.pre.migrationsqlite file will be created which would be your original db before any migrations as backup. -
Using the
--config-initflag, users can re-initialize/overwrite the config files to default. -
Using the
--config-infoflag, users can get all the info about the config file and its settings.
