Skip to main content

A helper script 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 script 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 script.

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

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             Absoulte Path to the directory
  --delete              Delete all the files with 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.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ebook-convert-helper-0.3.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.2 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.tar.gz
Algorithm Hash digest
SHA256 79180455bed7a9dc135d97c56ba526742a897c1b417cebeb390e2153a36eedd2
MD5 9a5634b16c334069bfa5823fbc511e76
BLAKE2b-256 1604d742178207e3edec74a1aae3a5d633348711c4e7637ce1dd9b6ab29df465

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ebook_convert_helper-0.3-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/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.2 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-py3-none-any.whl
Algorithm Hash digest
SHA256 1a673f64355295b30ad5ef6f0bb718d0de04296dfc1cb5dbeccd3ed7c00bd560
MD5 f48bfd03bdbe81037b8221117f35ceb2
BLAKE2b-256 b96412fb69c73b3c5f717352aa217d97b5b99e59a0f760653a3b61f473853248

See more details on using hashes here.

Supported by

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