https://github.com/garethr/booky

script to build compile a book from text file
https://github.com/garethr/booky

Last synced: 3 months ago
JSON representation

script to build compile a book from text file

• Host: GitHub
• URL: https://github.com/garethr/booky
• Owner: garethr
• Created: 2008-12-20T18:07:01.000Z (about 16 years ago)
• Default Branch: master
• Last Pushed: 2009-02-08T21:51:03.000Z (almost 16 years ago)
• Last Synced: 2024-10-04T16:49:28.992Z (3 months ago)
• Language: Python
• Homepage:
• Size: 96.7 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.textile

Awesome Lists containing this project

README

        
h2. Purpose

Booky is a simple application that helps with writing a single work, probably about or at least containing code. The main purpose is to take a collection of html fragments and code snippets and to compile them together into a pdf or other document, hopefully running a test suite against the code at the same time.

h2. Usage

Booky. Build tool for books. Takes files from a source directory 

and generates output in the build directory in different formats.

-o, --output [format]      supports html (default), txt or pdf

-p, --processor [from]     supports textile (default), markdown or none

-c, --clean                removes all files from the build directory

-h, --help                 display this help message


h2. Inspiration

Their are a few pieces of software that already solve a subset or superset of this problem. They have the advantage of being finished and in active use, and the disadvantage of being more general in scope, and hence more complicated. Do have a look at the following as they might be a better fit for your needs:

* Sphinx (http://sphinx.pocoo.org)

* Vellum (https://launchpad.net/vellum/)

* ReStructured Text (http://docutils.sourceforge.net/rst.html)

* CSS2XSLFO (http://www.re.be/css2xslfo/index.xhtml)

* LaTeX (http://www.latex-project.org/)

h2. Requirements

The following modules are required for all the callbacks to work. If you don't need the relevant functionality though everything should run without them.

* Idiopidae (http://www.zedshaw.com/projects/idiopidae/)

* Textile (http://pypi.python.org/pypi/textile)

* Markdown (http://www.freewisdom.org/projects/python-markdown/)

* Pisa (http://www.htmltopdf.org/)

* BeautifulSoup (http://crummy.com/software/BeautifulSoup)

* Pygments (http://pygments.org/)

Currently if you try something that requires a module you don't have you'll get a nice error.

h2. Installation

It's packaged with setuptools so as long as you have that installed you should be able to just run:

python setup.py install


If you're hacking on the software I'd recommend running it in development mode.

python setup.py develop