

This plugin will be spread over a few files (to keep the code clean). This is a trivial plugin, lets move on toĪ more complex example that actually adds a component to the user interface. You can download the Hello World plugin fromĮvery time you use calibre to convert a book, the plugin’s run() method will be called and theĬonverted book will have its publisher set to “Hello World”.

If you installed calibre in /Applications the command line toolsĪre in /Applications/calibre.app/Contents/MacOS/. On macOS, the command line tools are inside the calibre bundle, for example, The folder in which you created _init_.py:

To add this code to calibre as a plugin, simply run the following in publisher = 'Hello World' set_metadata ( file, mi, ext ) return path_to_ebook lower () mi = get_metadata ( file, ext ) mi. The documentation has also been updated to reflect 2.x modifications.From calibre.customize import FileTypePlugin class HelloWorld ( FileTypePlugin ): name = 'Hello World Plugin' # Name of the plugin description = 'Set the publisher to Hello World for all new conversions' supported_platforms = # Platforms this plugin will run on author = 'Acme Inc.' # The author of this plugin version = ( 1, 0, 0 ) # The version number of this plugin file_types = # The file types that this plugin will be applied to on_postprocess = True # Run this plugin after conversion is complete minimum_calibre_version = ( 0, 7, 53 ) def run ( self, path_to_ebook ): from import get_metadata, set_metadata with open ( path_to_ebook, 'r+b' ) as file : ext = os. If you upgrade from Ubooquity 1.x, read the 2.0.0 release notes, as they contain important information about database and preferences format changes (in a nutshell, you'll have to reconfigure Ubooquity and rescan your collection).
