logo

calibre filter

← Back to Filter List

calibre


Runs `ebook-convert` command (part of calibre) Generates various output formats (including .mobi for Kindle) http://manual.calibre-ebook.com/cli/ebook-convert.html

Aliases for this filter

  • calibre
  • ebook

Converts from file formats:

  • .html
  • .epub
  • .azw
  • .chm
  • .comic
  • .djvu
  • .pdf
  • .mobi
  • .lit
  • .fb2

To file formats:

  • .mobi
  • .epub
  • .fb2
  • .htmlz
  • .lit
  • .lrf
  • .pdf
  • .rtf
  • .snb
  • .tcr
  • .txt
  • .txtz
  • .html
  • .pml

Available settings:

SettingDescriptionDefault
add-new-filesBoolean or list of extensions/patterns to match.False
added-in-versionDexy version when this filter was first available.
additional-doc-filtersFilters to apply to additional documents created as side effects.{}
additional-doc-settingsSettings to apply to additional documents created as side effects.{}
argsArguments to be passed to the executable.
check-return-codeWhether to look for nonzero return code.True
clargsArguments to be passed to the executable (same as 'args').
command-stringThe full command string.%(prog)s "%(script_file)s" "%(output_file)s" %(args)s
data-typeAlias of custom data class to use to store filter output.generic
envDictionary of key-value pairs to be added to environment for runs.{}
examplesTemplates which should be used as examples for this filter.[]
exclude-add-new-filesList of patterns to skip even if they match add-new-files.[]
exclude-new-files-from-dirList of directories to skip when adding new files.[]
executableThe executable to be runebook-convert
extFile extension to output.None
extension-mapDictionary mapping input extensions to default output extensions.None
helpHelp string for filter, if not already specified as a class docstring.Runs `ebook-convert` command (part of calibre) Generates various output formats (including .mobi for Kindle) http://manual.calibre-ebook.com/cli/ebook-convert.html
initial-timeout10
input-extensionsList of extensions which this filter can accept as input.['.html', '.epub', '.azw', '.chm', '.comic', '.djvu', '.pdf', '.mobi', '.lit', '.fb2']
install-dir/usr/local/lib/python3.8/site-packages/dexy/filters
keep-originalsWhether, if additional-doc-filters are specified, the original unmodified docs should also be added.False
make-dummy-outputWhether to make a dummy output file when one is not generated and add-new-files is True.False
mkdirA directory which should be created in working dir.None
mkdirsA list of directories which should be created in working dir.[]
nodocWhether filter should be excluded from documentation.False
outputWhether to output results of this filter by default by reporters such as 'output' or 'website'.True
output-extensionsList of extensions which this filter can produce as output.['.mobi', '.epub', '.fb2', '.htmlz', '.lit', '.lrf', '.pdf', '.rtf', '.snb', '.tcr', '.txt', '.txtz', '.html', '.pml']
override-workspace-exclude-filtersIf True, document will be populated to other workspaces ignoring workspace-exclude-filters.False
path-extensionsstrings to extend path with['/Applications/calibre.app/Contents/MacOS']
preserve-prior-data-classWhether output data class should be set to match the input data class.False
record-varsWhether to add code that will automatically record values of variables.False
require-outputShould dexy raise an exception if no output is produced by this filter?True
scriptargsArguments to be passed to the executable.
tagsTags which describe the filter.['ebook']
timeout10
use-wdWhether to use a custom working directory when running filter.True
variablesA dictionary of variable names and values to make available to this filter.{}
varsA dictionary of variable names and values to make available to this filter.{}
version-commandCommand to call to return version of installed software.ebook-convert --version
windows-version-commandCommand to call on windows to return version of installed software.None
workspace-exclude-filtersFilters whose output should be excluded from workspace.['pyg']
workspace-includesIf set to a list of filenames or extensions, only these will be populated to working dir.None
write-stderr-to-stdoutShould stderr be piped to stdout?True

Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.