Skip to main content

The Project Gutenberg tool to generate EPUBs and other ebook formats.

Project description

# EbookMaker

EbookMaker is the tool used for format conversion at Project Gutenberg. It builds EPUB2 and Kindle files from HTML. Also it builds HTML4, EPUB2, Kindle, and PDF files from reST sources.

## Prerequisites

For cover generation

  • Cairo https://www.cairographics.org/download/

  • Noto Sans and Noto Sans CJK:
    • CentOS or RedHat: yum install google-noto-sans-cjk-fonts; yum install google-noto-sans-fonts

    • Ubuntu: apt-get install fonts-noto-cjk fonts-noto

Tested with Python 3.6

## Install

(master branch, editable install) pipenv install ebookmaker

Use the ebookmaker.conf file to pass a path to your kindlegen, tex, and groff programs if they’re not in your PATH. Edit the ebookmaker.conf and copy it to /etc/ebookmaker.conf to reset the paths. Copy ebookmaker.conf to ~/.ebookmaker to override settings in /etc/ebookmaker.conf or to set default command line options.

## Sample invocation

(From the directory where you ran pipenv install)

pipenv shell ebookmaker -v -v –make=epub.images –output-dir=/Documents/pg /Documents/library/58669/58669-h/58669-h.htm

or

pipenv run ebookmaker -v -v –make=epub.images –output-dir=/Documents/pg /Documents/library/58669/58669-h/58669-h.htm

# new to pipenv?

Install pipenv (might be pip install –user pipenv, depending on your default python)

$ pip3 install –user pipenv

The default install location is ${HOME}/.local/bin, so add this to your login shell’s ${PATH} if needed.

Change directories to where you want to have your ebookmaker environment. Then, to initialize a python 3 virtual environment, do

$ pipenv –three

Whenever you want to enter this environment, move to this directory and do:

$ pipenv shell

Install the gutenberg modules:

$ pipenv install ebookmaker

Check your install:

$ ebookmaker –version EbookMaker 0.6.0

Since you’re in the shell, you can navigate to a book’s directory and convert it:

$ ebookmaker -v -v –make=epub.images –ebook 10001 –title “The Luck of the Kid” –author “Ridgwell Cullum” luck-kid.html

## Update

$ cd ebookmaker to whever you ran $ pipenv install ebookmaker

then:

$ pipenv update ebookmaker

## Test

Install, as above.

$ cd ebookmaker to whever you ran $ pip install ebookmaker

then:

$ git checkout master

$ pipenv install -e .

$ python setup.py test

Travis-CI will run tests on branches committed in the gutenbergtools org

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

ebookmaker-0.8.2.tar.gz (137.0 kB view details)

Uploaded Source

File details

Details for the file ebookmaker-0.8.2.tar.gz.

File metadata

  • Download URL: ebookmaker-0.8.2.tar.gz
  • Upload date:
  • Size: 137.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.4

File hashes

Hashes for ebookmaker-0.8.2.tar.gz
Algorithm Hash digest
SHA256 c989bd882eb3f092eb6cd2d56576a83bb7e063b0f7ddc2bd43ddf25cf86a83a8
MD5 214cb47d1b6683d7bb0a48d0f8b0faba
BLAKE2b-256 f9a1b4bb8d9e45bbbd43ac2dcc7c45c279e11012e8bf7f795767ee4fd00e4020

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