pdfreactor.parsecfg 1.0.1

Limitations

We are still limited in what we can process; for stylesheets, for example, the API expects “objects” (in JSON terms; Python: dictionaries), not just URIs. For now, we take strings as URI specifications:

integrationStyleSheets = ['++resource++pdfreactor.plone/export.css']

is converted to:

{'integrationStyleSheets': [{
    'uri': '++resource++pdfreactor.plone/export.css'
    }]
 }

API methods conversion

We provide as well a (still incomplete and/or experimental – “use on your own risk”) conversion function which allows you to convert API calls, as they have been used until PDFreactor v7; for example:

enableDebugMode()

would be transformed to this config value:

{'debugSettings': {'appendLogs': True}}

This is not done by default; use:

from pdfreactor.parsecfg.oldmethods import convert_api_method
parse_configuration(..., convert=convert_api_method)

to make it happen.

Installation

Simply install the configuration parser by using pip:

pip install pdfreactor.parsecfg

or, for projects using buildout, add to your buildout.cfg script:

[buildout]
...
eggs =
    pdfreactor.parsecfg

and then run bin/buildout.

This will get you the pdfreactor-api package as well.

After restarting your Zope instance, you’ll find the package in the Quick-Installer or the Plone Add-Ons view.

Plone integration

After restarting your Zope instance with pdfreactor.parsecfg (and, likely, pdfreactor.plone) added to your eggs, simply use the Plone Add-Ons view or the Quick-Installer to activate it.

Then you may use the configuration registry and use the IPdfReactorConversionSettings prefix to adjust your conversion preferences.

Note: This package is about configuration parsing, not primarily about Zope / Plone. To have the PDFreactor web service use your actual session cookies, use pdfreactor.plone as well.

Possible values

For the values which will be recognized by the PDFreactor backend, please refer to the documentation by RealObjects GmbH:

• PDFreactor Web service documentation

If, for example, the documentation for the debugSettings model tells you about the boolean properties appendLogs, attachConfiguration, attachDocuments, attachResources, forceResult and all, this means that you may configure e.g.:

debugSettings.all = on

or:

debugSettings = {
    appendLogs: yes,
    forceResult: true,
}

Other packages

• pdfreactor-api, the required API distribution package

1.0.1 (2023-01-20)

Bugfixes:

• For userScripts, we need to create dictionaries with ‘uri’ keys as well.

Miscellaneous:

• Obsolete files and directories removed

[tobiasherp]

1.0.0 (2022-07-12)

• Initial release. [tobiasherp]