pp.client-python


Namepp.client-python JSON
Version 3.0.1 PyPI version JSON
download
home_pagehttp://pypi.python.org/pypi/pp.client-python
SummaryProduce & Publish Python Client
upload_time2023-02-07 09:51:07
maintainer
docs_urlhttps://pythonhosted.org/pp.client-python/
authorAndreas Jung
requires_python
license
keywords web pyramid pylons
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            pp.client-python
================

Produce & Publish bindings for Python.

The ``pp.client-python`` bindings can be used to communicate
with the Produce & Publish server ``pp.server`` for generating
PDF from Python applications .

Requirements
------------

- Python 3.7 or higher

Source code
-----------

https://bitbucket.org/ajung/pp.client-python

Bug tracker
-----------

https://bitbucket.org/ajung/pp.client-python/issues

Documentation
-------------

https://pythonhosted.org/pp.client-python

API
---

pdf API 
+++++++

The ``pdf`` API supports the conversion of HTML/XML to PDF
through the following PDFconverters:

- PDFreactor 
- PrinceXML 
- Speedata Publisher 
- Vivliostyle Formatter 
- PagedJS
- Typeset.sh
- Weasyprint
- Antennahouse

The PDF conversion process is based on the "CSS Paged Media" approach
where the input documents (XML or HTML) are styled using CSS only.

The ``pdf`` API of ``pp.client-python`` expects that the input
file and all related assets (images, stylesheets, font files etc.)
are placed within a working directory. The input file must be named 
``index.html``.

Using the commandline frontend::

    $ ../bin/pp-pdf  --help
    usage: pp-pdf [-h] [-f princexml] [-o] [-a] [-s http://localhost:6543]
                  [-t None] [-c] [-v]
                  source_directory [cmd_options]

    positional arguments:
      source_directory      Source directory containing content and assets to be
                            converted
      cmd_options           []

    optional arguments:
      -h, --help            show this help message and exit
      -f prince, --converter prince
                            PDF converter to be used (prince, pdfreactor, publisher)
      -o , --output         Write result ZIP to given .zip filename
      -s http://localhost:6543, --server-url http://localhost:6543
                            URL of Produce & Publish server)
      -t None, --authorization-token None
                            Authorization token for P&P server
      -v, --verbose         Verbose mode


The same functionality is available to any Python application through the 
``pdf()`` API of the ``pp.client-python`` module::


    from pp.client.python.pdf import pdf

    def pdf(source_directory,
            converter='prince', 
            output='',
            cmd_options='',
            server_url='http://localhost:8000',
            authorization_token=None,
            verbose=False):

Support
-------

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

License
-------
``pp.client-python`` is published under the GNU Public License V2 (GPL 2).

Contact
-------

| Andreas Jung/ZOPYX 
| Hundskapfklinge 33
| D-72074 Tuebingen, Germany
| info@zopyx.com
| www.zopyx.com


CHANGES
=======

3.0.1 (2023-02-07)
------------------
- modernized codebase
- no feature changes

3.0.0 (2020-02-14)
------------------
- adopted to new pp.server 3.x server API
- code cleanup
- better logging implementation 

0.5.1 (2019-08-02)
------------------
- fixed Python 3 deprecation warning

0.5.0 (2018-07-14)
------------------
- compatibility with pp.server 2.0
- removed async support  

0.4.5 (2017-08-08)
------------------
- disabled option to by-pass SSL cert checks

0.4.4 (2015-11-14)
------------------
- support for Vivliostyle Formatter

0.4.2 (2015-02-02)
------------------
- support for /api/available-converters (requires pp.server>=0.6.1)

0.4.1 (2014-11-19)
------------------
- experimental support for Speedata Publisher

0.4.0 (2014-10-13)
------------------
- compatiblity with Python 3.3 and 3.4
- dropped Python 2.6 support

0.3.6 (24-01-2014)
------------------
- added option '-c' to most commandline script in order
  for explicit SSL cert validation 

0.3.5 (24-01-2014)
------------------
- disabled SSL cert validation since Python/requests module
  can not deal properly with the StartCOM SSL cert of
  https://pp-server.zopyx.com

0.3.4 (21-01-2014)
------------------
- updated unoconv API documentation

0.3.3 (13-01-2014)
------------------
- support for server side token-based authorization

0.3.2 (13-01-2014)
------------------
- import fix

0.3.1 (21-10-2013)
------------------
- fixed an open file issue on Windows
  https://bitbucket.org/ajung/pp.client-python/issue/1/

0.3.0 (17-10-2013)
------------------
- Python 3.3 compatibility

0.2.9 (06-10-2013)
------------------
- added API methods for ``version`` and ``converters`` API
  of pp.server webservice

0.2.8 (05-10-2013)
------------------
- added support for ``cmd_options`` parameter
  for pp.server==0.3.5

0.2.7 (03-10-2013)
------------------
- documentation update

0.2.6 (14-07-2013)
------------------
- better error handling
- fixed issues with format() calls under Python 2.6

0.2.0 (06-07-2013)
------------------
- minor fixes
- moved documentation to Sphinx

0.1.5 (04-07-2013)
------------------
- implemented poll support
- fixes

0.1.4 (04-07-2013)
------------------
- added async support to pp-pdf commandline frontend

0.1.3 (03-07-2013)
------------------
- pdf converter parameter not properly propagated

0.1.2 (03-07-2013)
------------------
- logger fixes/changes

0.1.0 (03-07-2013)
------------------

- initial release

            

Raw data

            {
    "_id": null,
    "home_page": "http://pypi.python.org/pypi/pp.client-python",
    "name": "pp.client-python",
    "maintainer": "",
    "docs_url": "https://pythonhosted.org/pp.client-python/",
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "web pyramid pylons",
    "author": "Andreas Jung",
    "author_email": "info@zopyx.com",
    "download_url": "https://files.pythonhosted.org/packages/36/4b/883fc31a7de495e8aa02aad2196e2bd64d6c560e1b970acf4da9f6fe7398/pp.client-python-3.0.1.tar.gz",
    "platform": null,
    "description": "pp.client-python\n================\n\nProduce & Publish bindings for Python.\n\nThe ``pp.client-python`` bindings can be used to communicate\nwith the Produce & Publish server ``pp.server`` for generating\nPDF from Python applications .\n\nRequirements\n------------\n\n- Python 3.7 or higher\n\nSource code\n-----------\n\nhttps://bitbucket.org/ajung/pp.client-python\n\nBug tracker\n-----------\n\nhttps://bitbucket.org/ajung/pp.client-python/issues\n\nDocumentation\n-------------\n\nhttps://pythonhosted.org/pp.client-python\n\nAPI\n---\n\npdf API \n+++++++\n\nThe ``pdf`` API supports the conversion of HTML/XML to PDF\nthrough the following PDFconverters:\n\n- PDFreactor \n- PrinceXML \n- Speedata Publisher \n- Vivliostyle Formatter \n- PagedJS\n- Typeset.sh\n- Weasyprint\n- Antennahouse\n\nThe PDF conversion process is based on the \"CSS Paged Media\" approach\nwhere the input documents (XML or HTML) are styled using CSS only.\n\nThe ``pdf`` API of ``pp.client-python`` expects that the input\nfile and all related assets (images, stylesheets, font files etc.)\nare placed within a working directory. The input file must be named \n``index.html``.\n\nUsing the commandline frontend::\n\n    $ ../bin/pp-pdf  --help\n    usage: pp-pdf [-h] [-f princexml] [-o] [-a] [-s http://localhost:6543]\n                  [-t None] [-c] [-v]\n                  source_directory [cmd_options]\n\n    positional arguments:\n      source_directory      Source directory containing content and assets to be\n                            converted\n      cmd_options           []\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      -f prince, --converter prince\n                            PDF converter to be used (prince, pdfreactor, publisher)\n      -o , --output         Write result ZIP to given .zip filename\n      -s http://localhost:6543, --server-url http://localhost:6543\n                            URL of Produce & Publish server)\n      -t None, --authorization-token None\n                            Authorization token for P&P server\n      -v, --verbose         Verbose mode\n\n\nThe same functionality is available to any Python application through the \n``pdf()`` API of the ``pp.client-python`` module::\n\n\n    from pp.client.python.pdf import pdf\n\n    def pdf(source_directory,\n            converter='prince', \n            output='',\n            cmd_options='',\n            server_url='http://localhost:8000',\n            authorization_token=None,\n            verbose=False):\n\nSupport\n-------\n\nSupport for Produce & Publish Server and components is currently only available\non a project basis.\n\nLicense\n-------\n``pp.client-python`` is published under the GNU Public License V2 (GPL 2).\n\nContact\n-------\n\n| Andreas Jung/ZOPYX \n| Hundskapfklinge 33\n| D-72074 Tuebingen, Germany\n| info@zopyx.com\n| www.zopyx.com\n\n\nCHANGES\n=======\n\n3.0.1 (2023-02-07)\n------------------\n- modernized codebase\n- no feature changes\n\n3.0.0 (2020-02-14)\n------------------\n- adopted to new pp.server 3.x server API\n- code cleanup\n- better logging implementation \n\n0.5.1 (2019-08-02)\n------------------\n- fixed Python 3 deprecation warning\n\n0.5.0 (2018-07-14)\n------------------\n- compatibility with pp.server 2.0\n- removed async support  \n\n0.4.5 (2017-08-08)\n------------------\n- disabled option to by-pass SSL cert checks\n\n0.4.4 (2015-11-14)\n------------------\n- support for Vivliostyle Formatter\n\n0.4.2 (2015-02-02)\n------------------\n- support for /api/available-converters (requires pp.server>=0.6.1)\n\n0.4.1 (2014-11-19)\n------------------\n- experimental support for Speedata Publisher\n\n0.4.0 (2014-10-13)\n------------------\n- compatiblity with Python 3.3 and 3.4\n- dropped Python 2.6 support\n\n0.3.6 (24-01-2014)\n------------------\n- added option '-c' to most commandline script in order\n  for explicit SSL cert validation \n\n0.3.5 (24-01-2014)\n------------------\n- disabled SSL cert validation since Python/requests module\n  can not deal properly with the StartCOM SSL cert of\n  https://pp-server.zopyx.com\n\n0.3.4 (21-01-2014)\n------------------\n- updated unoconv API documentation\n\n0.3.3 (13-01-2014)\n------------------\n- support for server side token-based authorization\n\n0.3.2 (13-01-2014)\n------------------\n- import fix\n\n0.3.1 (21-10-2013)\n------------------\n- fixed an open file issue on Windows\n  https://bitbucket.org/ajung/pp.client-python/issue/1/\n\n0.3.0 (17-10-2013)\n------------------\n- Python 3.3 compatibility\n\n0.2.9 (06-10-2013)\n------------------\n- added API methods for ``version`` and ``converters`` API\n  of pp.server webservice\n\n0.2.8 (05-10-2013)\n------------------\n- added support for ``cmd_options`` parameter\n  for pp.server==0.3.5\n\n0.2.7 (03-10-2013)\n------------------\n- documentation update\n\n0.2.6 (14-07-2013)\n------------------\n- better error handling\n- fixed issues with format() calls under Python 2.6\n\n0.2.0 (06-07-2013)\n------------------\n- minor fixes\n- moved documentation to Sphinx\n\n0.1.5 (04-07-2013)\n------------------\n- implemented poll support\n- fixes\n\n0.1.4 (04-07-2013)\n------------------\n- added async support to pp-pdf commandline frontend\n\n0.1.3 (03-07-2013)\n------------------\n- pdf converter parameter not properly propagated\n\n0.1.2 (03-07-2013)\n------------------\n- logger fixes/changes\n\n0.1.0 (03-07-2013)\n------------------\n\n- initial release\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Produce & Publish Python Client",
    "version": "3.0.1",
    "split_keywords": [
        "web",
        "pyramid",
        "pylons"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "364b883fc31a7de495e8aa02aad2196e2bd64d6c560e1b970acf4da9f6fe7398",
                "md5": "2ddcdd5995d86b275dd0ed7b437e0780",
                "sha256": "3d02b87ff0109f8b6aa230c6c742c94be00158bdc2f2642b6ad4e24ba37b2c51"
            },
            "downloads": -1,
            "filename": "pp.client-python-3.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2ddcdd5995d86b275dd0ed7b437e0780",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8539,
            "upload_time": "2023-02-07T09:51:07",
            "upload_time_iso_8601": "2023-02-07T09:51:07.490529Z",
            "url": "https://files.pythonhosted.org/packages/36/4b/883fc31a7de495e8aa02aad2196e2bd64d6c560e1b970acf4da9f6fe7398/pp.client-python-3.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-07 09:51:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pp.client-python"
}
        
Elapsed time: 0.69986s