pdfreactor.parsecfg 1.0.0.dev6

Features

1. A parse_configuration function

2. In a Plone context, a pdfreactor-config browser view to make basic use of it, i.e. producing a config dictionary from:

3. a site-global textual conversion configuration which is stored in the Plone registry.

Note: Despite the fact that the license key – unless installed on the server – is put in the config dictionary, we consider this to connection-related, so we don’t expect you to put it in your conversion configuration.

You could do so (specifying it in one single string token), but e.g. our pdfreactor.plone package offers a dedicated setting in the IPdfReactorConnectionSettings interface.

Examples

The textual configuration could for example look like:

# line comments are possible
outputFormat = {
    width: 640,  # and so are eon-of-line comments
    type: OutputType.PNG_TRANSPARENT,
}

The symbols defined by the PDFreactor API class are recognized, so this would be converted to the following config dictionary:

{'outputFormat': {
    'width': 640,
    'type': 'PNG_TRANSPARENT',
    }
 }

This doesn’t look very magic, but it saves you from finding a way to save settings for each possible key; you just need one configuration string.

On the values side, we’ll accept valid configuration symbols only (case sensitively, so OutputType.png_transparent would cause an error) or valid Python string or number tokens; for conveniense, several common names for true, false and nothing are accepted (case-insensitively).

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'
    }]
 }

We provide as well a (still incomplete and/or experimental - “use on your onw 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=convert_api_method
parse_configuration(..., convert=convert_api_method)

to make this happen.

Documentation

pip install pdfreactor.parsecfg

[buildout]
...
eggs =
    pdfreactor.parsecfg

debugSettings.all = on

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

Support

If you are having issues concerning this configuration parser, please let us know; please use the issue tracker mentioned below.

For issues regarding the PDFreactor itself, please refer to RealObjects GmbH:

• PDFreactor Support Center

Contribute

(To this configuration parser package:)

• Issue Tracker: https://github.com/visaplan/pdfreactor.plone/issues

• Source Code: https://github.com/visaplan/pdfreactor.plone

License

The project is licensed under the MIT License.

Author

• Tobias Herp, tobias.herp@visaplan.com

Changelog

1.0.0 (unreleased)

• Initial release. [tobiasherp]