Giter Site home page Giter Site logo

bookmaker's Introduction

bookmaker

A tool for capturing, processing, editing, and converting physical books into electronic media such as PDF, DjVu and Epub.

Note: Currently undergoing lots of rewriting/refactoring/upgrades.

Installation

Currently only Ubuntu is supported by the install script, but support for other distros as well as OSX and Windows is planned.

  • Download and unzip

  • find install.py and run 'sudo python install.py'

Using bookmaker

Capturing

TODO

Processing

Processing will automatically detect the dimensions of all the pages and content as well as generate a clean crop box and record this in an Internet Archive-style 'scandata' XML file.

The minimum required to process a book is a project directory, for example, 'mybook_1', and a subdirectory of raw images (currently limited to jpgs for now). The raw image subdirectory should follow the naming convention NAME_raw_FILETYPE or NAME_RAW_FILETYPE. For example, 'mybook_1_RAW_jpg'.

Command line

To initialize the processing of a book, one would call bookmaker.py like so:

./bookmaker.py --root-dir /path/to/my/bookprojects/mybook_1

One can also pass more than one book at time, with a space between each entry, or alternatively pass an entire folder of project directories, like:

./bookmaker.py --root-dir /path/to/my/bookprojects

When processing multiple books, one book will be processed at a time, with each operation split across multiple cores when available.

If one does not care to edit the computer generated crop boxes, one can pass the following combination of arguments to derive the digital formats immediately after processing:

--language (for OCR (default is English))
--active-crop (the crop box that will be used for cropping (options are standardCrop (default), pageCrop, contentCrop))
--derive FORMAT (options are djvu, pdf, epub, text)
or
--derive-all

GUI

The GUI can be started by calling gui_main.py, like:

./gui_main.py

The first thing you will see is the main menu:

![Main Menu] (/imgs/main_menu.png)

Selecting 'process', will bring up the processing queue window:

![Processing Queue] (/imgs/processing_queue.png)

Add

Opens a user selection window for adding project directories to the queue.

Remove

Removes the selected project directory(s) from the queue.

Options

(Debugging options mostly likely to be hidden at some point but exposed for now)

Init

Begins the processing for the selected project directory(s).

Edit

Opens the editor for the selected project directory. Note that the processing must finish before one can edit the item.

An illustration of three items that are undergoing processing:

![Processing] (/imgs/processing.png)

Editing

TODO

bookmaker's People

Contributors

tom-kerr avatar

Stargazers

Norhan_ms avatar

Watchers

James Cloos avatar chuan yang avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.