skip to navigation
skip to content

Not Logged In

zopyx.convert2 2.1.0

A Python interface for the conversion of HTML to PDF, RTF, DOCX, WML and ODT) - belongs to zopyx.smartprintng.core

Package Documentation

Latest Version: 2.4.5

The zopyx.convert2 package helps you to convert HTML to PDF, RTF, ODT, DOCX and WML using XSL-FO technology or using PrinceXML. This package is used as the low-level API for zopyx.smartprintng.core.

Requirements

  • Java 1.5.0 or higher (FOP 0.94 requires Java 1.6 or higher)
  • csstoxslfo (included)
  • XFC-4.0 (XMLMind) for ODT, RTF, DOCX and WML support (if needed)
  • XINC 2.0 (Lunasil) for PDF support (commercial)
  • or FOP 0.94 (Apache project) for PDF support (free)
  • BeautifulSoup (will be installed automatically through easy_install. See Installation.)
  • ElementTree (will be installed automatically through easy_install. See Installation.)

Installation

  • install zopyx.convert2 either using easy_install or by downloading the sources from the Python Cheeseshop. This will install automatically the Beautifulsoup and Elementree modules if necessary.
  • the environment variable $XFC_DIR must be set and point to the root of your XFC installation directory
  • the environment variable $XINC_HOME must be set and to point to the root of your XINC installation directory
  • the environment variable $FOP_HOME must be set and point to the root of your FOP installation directory
  • the 'prince' binary must be in the $PATH if you are using PrinceXML

Supported platforms

Windows, Unix

Subversion repository

Usage

Some examples from the Python command-line:

from zopyx.convert2 import Converter
C = Converter('/path/to/some/file.html')
pdf_filename = C('pdf')         # using XINC
pdf2_filename = C('pdf2')       # using FOP
rtf_filename = C('rtf')
pdt_filename = C('odt')
wml_filename = C('wml')
docx_filename = C('docx')

A very simple command-line converter is also available:

html-convert --format rtf --output foo.rtf sample.html

html-convert has a --test option that will convert some sample HTML. If everything is ok then you should see something like that:

>html-convert --test
Entering testmode
pdf: /tmp/tmpuOb37m.html -> /tmp/tmpuOb37m.pdf
rtf: /tmp/tmpuOb37m.html -> /tmp/tmpuOb37m.rtf
docx: /tmp/tmpuOb37m.html -> /tmp/tmpuOb37m.docx
odt: /tmp/tmpuOb37m.html -> /tmp/tmpuOb37m.odt
wml: /tmp/tmpuOb37m.html -> /tmp/tmpuOb37m.wml
pdf: /tmp/tmpZ6PGo9.html -> /tmp/tmpZ6PGo9.pdf
rtf: /tmp/tmpZ6PGo9.html -> /tmp/tmpZ6PGo9.rtf
docx: /tmp/tmpZ6PGo9.html -> /tmp/tmpZ6PGo9.docx
odt: /tmp/tmpZ6PGo9.html -> /tmp/tmpZ6PGo9.odt
wml: /tmp/tmpZ6PGo9.html -> /tmp/tmpZ6PGo9.wml

How zopyx.convert2 works internally

  • The source HTML file is converted to XHTML using mxTidy
  • the XHTML file is converted to FO using the great "csstoxslfo" converter written by Werner Donne.
  • the FO file is passed either to the external XINC or XFC converter to generated the desired output format
  • all converters are based on Java technology make the conversion solution highly portable across operating system (including Windows)

Known issues

  • If you are using zopyx.convert2 together with FOP: use the latest FOP 0.94 only. Don't use any packaged FOP version like the one from MacPorts which is known to be broken.
  • Ensure that you have read the csstoxslfo documentation. csstoxslfo has several requirements about the HTML markup. Don't expect that it is the ultimate HTML converter. Any questions regarding the necessary markup are documented in the csstoxslfo documentation and will not be answered.

Author

zopyx.convert2 was written by Andreas Jung for ZOPYX Ltd. & Co. KG, Tuebingen, Germany.

License

zopyx.convert2 is published under the Zope Public License (ZPL 2.1). See LICENSE.txt.

Contact

ZOPYX Ltd. & Co. KG
c/o Andreas Jung,
Charlottenstr. 37/1
D-72070 Tuebingen, Germany
E-mail: info at zopyx dot com

Changes:

2.1.0 (2009-09-05)

  • Calibre integration
  • API change: convert() now returns a richer dict with all related conversion results

2.0.4 (2009-07-07)

  • pinned BeautifulSoup 3.0.x

2.0.3 (2009-07-05)

  • fix in fop.py

2.0.2 (2009-06-02)

  • fixed broken path for test data files

2.0.1 (2009-06-02)

  • added environment variable ZOPYX_CONVERT_EXECUTE_METHOD to control the usage of the process module vs. os.system() (in case of hanging Java processes). Possible values: 'process' (default), 'system'

2.0.0 (2009-05-14)

  • final release

2.0.0b3 (25.12.2008)

  • tidy: rewrite image references relative to the html file to be converted

2.0.0b2 (05.10.2008)

  • fixed some import errors
  • now working with zopyx.smartprintng.core

2.0.0b1 (04.10.2008)

  • initial release
  • complete new reimplementation of zopyx.convert
  • added support for PrinceXML
 
File Type Py Version Uploaded on Size
zopyx.convert2-2.1.0.tar.gz (md5) Source 2009-09-05 338KB
  • Downloads (All Versions):
  • 39 downloads in the last day
  • 460 downloads in the last week
  • 1863 downloads in the last month