fichub-cli
A CLI for the fichub.net API
To report issues upstream for the supported sites, visit https://fichub.net/#contact
To report issues for the CLI, open an issue at https://github.com/FicHub/fichub-cli/issues
Installation
From pip (Recommended)
pip install -U fichub-cli
From Github Source (Pre-release, for testing new features by Beta testers)
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 Format: epub (default), mobi, pdf or html
[default: epub]
--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
--version Display version & quit
--help Show this message and exit.
Default Configuration
- The fanfiction will be downloaded in epub format. To change it, use
-ffollowed by the format. - 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 --help for more info.
Example
- To download using an URL
fichub_cli -u https://archiveofourown.org/works/10916730/chapters/24276864
- To download using a file containing URLs
fichub_cli -i urls.txt
- To download using a comma separated list of URLs
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"
- To generate a changelog of the download
fichub_cli -i urls.txt --changelog
NOTE
--out-dir or -o can be used in all the above commands to select an output directory.
Plugin Support
Read the wiki for more info.
Helper Scripts
Helper scripts can be found here. They can add small functionalities to the CLI without needing to create full-fledged plugins.
Links
1 maintainer
Release files for fichub-cli 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fichub-cli-0.7.0.tar.gz | 15.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fichub_cli-0.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.7 kB
Release files / fichub-cli-0.7.0.tar.gz
| Download URL | fichub-cli-0.7.0.tar.gz |
|---|---|
| Size | 15.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c90338158cb6127c878ff41c5c99e02455bebb605e7ec0662a9cba59b76d974e
|
|
BLAKE2b-256 checksum How to use checksums |
588575cd3ad5df5b7d4d3860cd47f1cc7e7e103da612175b09e2224dca408076
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.5
|
Release files / fichub_cli-0.7.0-py3-none-any.whl
| Download URL | fichub_cli-0.7.0-py3-none-any.whl |
|---|---|
| Size | 17.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
90d96cf1b3cd0ebf2ed33d712ebfaf116f746ac4345ede05ef63d4958d9b57f7
|
|
BLAKE2b-256 checksum How to use checksums |
5d1f657030118c48fdde076ba1ccebca4b5710de4fd48e4683c8f940b0b4db6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.5
|
