catbook 0.1.0

No project description provided

catbook

A very simple docx file builder. Catbook was created to make managing book chapters simple. The goal was a minimal-markup way to concatenate text files into Word docs that could be converted to epub, mobi, pdf, etc.

The tool needed to:

• Allow chapters to be quickly rearranged
• Allow multi-section chapters
• Offer a trivially easy way to differentiate quotes, blocks, and special words
• Support three levels of hierarchy
• Include only the absolute minimum of markup and functionality

---

Catbook reads a flat list of text files from a "bookfile" and concatenates them into a Word doc. The doc may have up to three levels. The levels are titled using Word styles.

There are a very small number of markups to do things like italicize quotes, force a page break between sections, etc. Markup chars and fonts are minimally customizable using .ini files. See catbook/markup.py and catbook/fonts.py.

Metadata about the files that are concatenated as sections of the doc is available from the Book object and each section.

Bookfiles can have comments lines starting with #. You can specify the TITLE and AUTHOR using directives; they will be shown in the book's metadata. Preexisting docx files may be inserted using INSERT directives. Adding a METADATA directive inserts a page with a table containing the author, title, bookfile path, word count and other metadata.

For e.g.

#
# this is a complete bookfile
# TITLE This is my book
# AUTHOR John Doe
#
# INSERT an-existing/file.docx
#
filesdir/section-1.txt
morefiles/section-2.txt
# INSERT another/file.docx
still/morefiles/section-2.txt
#
# METADATA
#

For usage, see main.py and/or test/test_builder.py.