Skip to main content

pp.server - Produce & Publish Server

Project description

Note

This new version 3 of the Produce & Publish server is a complete rewrite with an incompatible REST API. Version 3 also requires version 3 of the pp.client-python bindings.

pp.server is a FastAPI based server implementation and implements the server side functionality of the Produce & Publish platform. It is known as the Produce & Publish Server.

The Produce & Publish Server provided web service APIs for converting HTML/XML + assets to PDF using one of the following external PDF converters:

  • PrinceXML (www.princexml.com, commercial)
  • PDFreactor (www.realobjects.com, commercial)
  • Speedata Publisher (www.speedata.de, open-source, experimental support)
  • WKHTMLTOPDF (www.wkhtmltopdf.org, open-source, experimental support)
  • Vivliostyle Formatter (www.vivliostyle.com, commercial, experimental support)
  • VersaType Formatter (www.trim-marks.com, commercial, experimental support)
  • Antennahouse 7 (www.antennahouse.com, commercial)
  • Weasyprint (free, unsupported)
  • Typeset.sh (www.typeset.sh, commercial)
  • PagedJS (www.pagedjs.org, free)

In addition there is experimental support for generating EPUB documents using Calibre (www.calibre.org, open-source).

The web service provides only synchronous operation.

Requirements

  • Python 3.8 or higher, no support for Python 2.x

  • the external binaries

    • PrinceXML: prince,
    • PDFreactor: pdfreactor.py,
    • Speedata Publisher: sp
    • Calibre: ebook-convert
    • WKHTMLTOPDF: wkhtmltopdf
    • Vivliostyle: vivliostyle-formatter
    • VersaType : versatype-converter
    • Weasyprint: weasyprint
    • Antennahouse: run.sh
    • Typeset.sh: typeset.sh.phar
    • PageJS: pagedjs-cli

    must be in the $PATH. Please refer to the installation documentation of the individual products.

Installation

  • create a Python 3 virtual environment using:

    python3 -m venv pp.server
    
  • install the Produce & Publish server:

    bin/pip install pp.server
    
  • run the Produce & Publish server:

    bin/uvicorn pp.server.server:app
    
  • or under control of gunicorn:

    bin/gunicorn pp.server.server:app -w 2 -k uvicorn.workers.UvicornWorker
    
  • For running the Produce & Publisher server under control of the process manager circus, generate the circusd.ini file using:

    bin/pp-server-templates
    
  • and start it in background:

    bin/circusd circusd.ini  --daemon
    

Converter requirements

For the PDF conversion the related converter binaries or scripts must be included in the $PATH of your server.

  • prince for PrinceXML
  • pdfreactor for PDFreactor 8 or higher
  • wkhtmltopdf for WKHTMLToPDF
  • ebook-convert for Calibre
  • sp for the Speedata Publisher
  • vivliostyle for the Vivliostyle formatter
  • versatype for the Versatype converter
  • weasyprint for Weasyprint
  • antennahouse for the Antennahouse
  • pagedjs for the PagedJS
  • typesetsh for the Typeset.sh

API documentation

All API methods are available through a REST api following API URL endpoint:

http://host:port/<command>

With the default server configuration this translates to:

http://localhost:8000/convert

REST API Introspection

pp.server is implemented based on the FastAPI framework for Python. You can access the REST API documentation directly through

http://localhost:8000/docs

Environment variables

pp.server uses the var folder of the installation directory by default as temporary folder for conversion data. Set the environment variable PP_SPOOL_DIRECTORY if you need different spool directory instead.

If you run PDFreactor 10 or higher under Docker then you must set the environment variable PP_PDFREACTOR_DOCKER=1 in order to generated a proper file:///docs/… URI for pdfreactor.py.

PDF conversion API

Remember that all converters use HTML or XML as input for the conversion. All input data (HTML/XML, images, stylesheets, fonts etc.) must be stored in ZIP archive. The filename of the content must be named index.html.

You have to POST the data to the

http://host:port/convert

with the following parameters:

  • data - the ZIP archive (as base64 encoded string)
  • converter - a string that determines the the PDF converter to be used (either princexml, pdfreactor, phantomjs, vivliostyle, versatype, or calibre for generating EPUB content)
  • cmd_options - an optional string of command line parameters added as given to the calls of the externals converters

Returns:

The API returns its result as JSON structure with the following key-value pairs:

  • status - either OK or ERROR
  • data- the generated PDF file encoded as base64 encoded byte string
  • output - the conversion transcript (output of the converter run)

Introspection API methods

Produce & Publish server version:

http://host:port/version

returns:

{“version”: “3.0.0”, “module”: “pp.server”}

Installed/available converters:

http://host:port/converters

returns:

{“pdfreactor”: true, “phantomjs”: false, “calibre”: true, “prince”: true}

Versions of installed converter:

http://host:port/converter-versions

returns:

{‘prince’: ‘Version x.y’, ‘pdfreactor: ‘Version a.b.c’, …}

Other API methods

Cleanup of the queue directory (removes conversion data older than one day)

http://host:port/cleanup

returns:

{“directories_removed”: 22}

Support

Support for Produce & Publish Server is currently only available on a project basis.

License

pp.server is published under the GNU Public License V2 (GPL 2).

Contact

ZOPYX
Hundskapfklinge 33
D-72074 Tuebingen, Germany
www.zopyx.com
www.produce-and-publish.info

3.2.0 (2020/05/12)

  • added selftest endpoint

3.1.0 (2020/03/20)

  • various minor fixes
  • available_converters() now executed in parallel -> speedup

3.0.0 (2020/02/14)

  • complete rewrite using FastAPI as REST backend
  • better logging
  • changed API names
  • dropped support for PhantomJS and Unoconv
  • better error handling
  • simplified configuration for further converter support

2.1.0 (2020/08/12)

  • support for pagedjs-cli and typeset.sh added

2.0.4 (2019/02/11)

  • minor installation issues with var folder gunicorn.log
  • added optional PP_PDFREACTOR_DOCKER environment support

2.0.3 (2019/02/11)

  • minor installation issues with var folder gunicorn.log
  • added optional PP_SPOOL_DIRECTORY environment support

2.0.0 (2018/07/14)

  • major cleanup
  • removed async functionality
  • switched from waitress to gunicorn
  • switched from subprocess to easyprocess
  • webpage displays installed converters and their versions
  • support for VersaType converter added

1.0.8 (2017/10/23)

  • internal release

1.0.7 (2017/08/17)

  • fixed a very old bug in cleanup code

1.0.6 (2017/08/08)

  • display available converters during startup

1.0.5 (2017/04/06)

  • support for WeasyPrint

1.0.3 (2017/02/13)

  • calling princexml with explicit option -o (Prince 11 compatibility)

1.0.0 (2017/01/08)

  • first official release
  • requires Python 3.5 or higher

0.7.13 (2016/08/30)

  • added circus dependency in order to provide daemonizing support out of the box

0.7.12 (2016/08/29)

  • fix for PDFreactor 8

0.7.11 (2016/06/01)

  • updated to Pyramid 1.7

0.7.7 (2016/01/24)

  • updated support for latest Vivliostyle formatter
  • added support for Antennahouse Formatter

0.7.6 (2015/11/30)

  • support for PDFreactor 8

0.7.5 (2015/11/18)

  • fixed race condition while creating directories

0.7.4 (2015/11/14)

  • support for nested uploaded ZIP files

0.7.3 (2015/11/14)

  • support for Vivliostyle Formatter

0.7.2 (2015/04/20)

0.7.1 (2015/03/13)

  • unicode fix in runcmd()

0.7.0 (2015/02/15)

  • 0.6.x was completely badly packaged
  • changed repo structure

0.6.1 (2015/02/02)

  • add /api/converter-versions to webservice API

0.6.0 (2015/01/26)

  • dropped Python 2.X support, Python 3.3 or higher is now a mandatory requirement

0.5.5 (2015/01/23)

  • UTF8 handling fix

0.5.3 (2014/11/23)

  • support for WKHTMLTOPDF

0.5.2 (2014/11/19)

  • support for Speedata Publisher

0.5.1 (2014/10/12)

  • improved error handling

0.5.0 (2014/10/12)

  • official Python 3.3/3.4 support

0.4.7 (25.09.2014)

  • fixed documentation bug

0.4.6 (22.08.2014)

  • removed PDFreactor –addlog option

0.4.5 (22.08.2014)

  • added supplementary commandline options to pdfreactor commandline call

0.4.4 (24.01.2014)

  • minor typos fixed

0.4.3 (20.01.2014)

  • implemented automatic queue cleanup after one day

0.4.2 (18.01.2014)

  • URL fix in index.pt related to virtual hosting

0.4.1 (13.01.2014)

  • show Python version and converters on index.pt
  • authorization support added

0.4.0 (17.10.2013)

  • Python 3.3 support
  • Pyramid 1.5 support

0.3.5 (05.10.2013)

  • added ‘cmd_options’ to pdf and unoconv API methods for specifying arbitary command line parameters for the external converters

0.3.4 (05.10.2013)

  • added ‘cleanup’ API

0.3.3 (05.10.2013)

  • added ‘version’ and ‘converter’ API methods

0.3.2 (04.10.2013)

  • added support EPUB conversion using Calibre

0.3.1 (03.10.2013)

  • updated documentation

0.3.0 (14.07.2013)

  • unoconv conversion now returns a ZIP archive (e.g. a HTML file + extracted images)

0.2.7 (06.07.2013)

  • added support for Phantom.js converter

0.2.5 (05.07.2013)

  • better detecting of prince and pdfreactor binaries

0.2.2 (05.07.2013)

  • updated the documentation
  • minor cleanup

0.2.1 (04.07.2013)

  • re-added poll API

0.2.0 (03.07.2013)

  • converted XML-RPC api to REST api

0.1.9 (01.07.2013)

  • monkeypatch pyramid_xmlrpc.parse_xmlrpc_request in order to by-pass its stupid DOS request body check

0.1.7 (29.06.2013)

  • more tests
  • fixes
  • updated documentation

0.1.5 (27.06.2013)

  • test for synchronous operations
  • fixes

0.1.0 (24.06.2013)

  • initial release

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.

Files for pp.server, version 3.2.0.6
Filename, size File type Python version Upload date Hashes
Filename, size pp.server-3.2.0.6.tar.gz (1.1 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page