Getting Started

First, you need to download Calibre’s command line tools.

You can follow instructions on Calibre’s site to download, or download through package managers:

# on Ubuntu
sudo apt-get install calibre

# on MacOS
brew install calibre

On MacOS, the command line tools may not be added to your path. To access them, add /Applications/calibre.app/Contents/MacOS/ to your PATH variable, for instance in ~/.bashrc adding

export PATH=$PATH:/Applications/calibre.app/Contents/MacOS/

Then, just install Capybre with pip!

pip install capybre

Simple Usages

Here are a few simple usages to get you up and running. For more detail, see the other docs:

# convert between formats; creates 'PrideAndPrejudice.mobi'

from capybre import convert

convert('PrideAndPrejudice.epub', as_ext='mobi')


# extract metadata
from capybre import extract_metada

metadata = extract_metadata('PrideAndPrejudice.epub')

# prints "Pride and Prejudice"
print(metadata.title)


# extract cover from metadata; saves as cover.jpg
from capybre import extract_cover

extract_cover('PrideAndPrejudice.epub', output_file='cover.jpg')


# fetch metadata from internet sources
from capybre import fetch_metadata

metadata = fetch_metadata(title='Pride and Prejudice')

# prints Jane Austen
print(metadata.author)


# download cover from internet sources; saves as cover.jpg
from capybre import fetch_cover

fetch_cover(title='Pride and Prejudice')