Skip to main content

A helper cli for calibre's ebook-convert CLI which is used to convert all files in an directory into another format.

Project description

calibre-ebook-convert-helper

A helper CLI for calibre's ebook-convert CLI which is used to convert all files in an directory into another format.

Calibre needs to be installed to use this CLI.

Supported sites which are compatible with Calibre can be found here: https://manual.calibre-ebook.com/generated/en/ebook-convert.html

To report issues for the CLI, open an issue at https://github.com/arzkar/calibre-ebook-convert-helper/issues

Installation

From pip (Recommended)

pip install -U ebook-convert-helper

From Github Source (Pre-release, for testing new features by Beta testers)

pip install git+https://github.com/arzkar/calibre-ebook-convert-helper@main

Usage

> ebook-convert-helper --help
usage: ebook-convert-helper [-h] -i INPUT_FORMAT -o OUTPUT_FORMAT --dir
                                    DIR [--delete-file] [-r] [--verbose] [--debug]
                                    [--log] [--version]

A helper CLI for calibre's ebook-convert CLI which is used to convert all files in an directory into another format.

Calibre needs to be installed to use this CLI.

Supported sites which are compatible with Calibre can be found here: https://manual.calibre-ebook.com/generated/en/ebook-convert.html

To report issues for the CLI, open an issue at https://github.com/arzkar/calibre-ebook-convert-helper/issues

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_FORMAT, --input-format INPUT_FORMAT
                        Input format
  -o OUTPUT_FORMAT, --output-format OUTPUT_FORMAT
                        Output format
  --dir DIR             Absolute Path to the directory
  --delete              Delete all the files containing the Input format
  -r, --recursive       Convert all files from both the directory and its sub-directories
  --ignore              Read directories or files from .echignore which will be excluded from the conversion
  --verbose             Show ebook-convert's stdout
  --debug               Show the log in console
  --log                 Generate a log file in the current directory
  --version             Display version & quit

Example

  • To convert all mobi files inside the directory ~/Books into azw3
ebook-convert-helper -i mobi -o azw3 --dir ~/Books
  • To include all the sub-directories inside the --dir directory, use --recursive
ebook-convert-helper -i mobi -o azw3 --dir ~/Books --recursive
  • To delete the all the files with -i, --input-format i.e. mobi, use --delete
ebook-convert-helper -i mobi -o azw3 --dir ~/Books --delete
  • To ignore directories or files, use --ignore which will read the .echignore file from the root directory specified by --dir and exclude its contents
ebook-convert-helper -i mobi -o azw3 --dir ~/Books --ignore

Note

.echignore file needs to be in the root directory which is specified by --dir. Each directory or file needs to be in its own line and the path can either be relative or absolute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ebook-convert-helper-0.3.2.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

ebook_convert_helper-0.3.2-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file ebook-convert-helper-0.3.2.tar.gz.

File metadata

  • Download URL: ebook-convert-helper-0.3.2.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using 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.63.1 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.5

File hashes

Hashes for ebook-convert-helper-0.3.2.tar.gz
Algorithm Hash digest
SHA256 ca7125a42b562b6ffc16216fc81b1ae021e693f12d2f9e2e522491e814059692
MD5 40a0abd07fbbfec94fe5503462ed4ac3
BLAKE2b-256 e16261532e4f81dbfd702fee21229a96b49e3fac484014b6c0352d478bdf06bf

See more details on using hashes here.

File details

Details for the file ebook_convert_helper-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: ebook_convert_helper-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using 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.63.1 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.5

File hashes

Hashes for ebook_convert_helper-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d462bac845bcce19eb0ee48865a5357bc798a9ce1103af53c5e66b302d8412bc
MD5 c1d115fdf985c58854ed55160f46327a
BLAKE2b-256 6e347e4e1c8adbd91ca18fb23e0547f5bcb1652e3dd7b78d33f28ee56bd642d0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page