Compatibility

Compatibility#

plone-client talks to a site only through plone.restapi. What a site supports depends on the plone.restapi version it runs, not on plone-client.

Plone and plone.restapi versions#

Plone

plone.restapi

Status

6.2.0

10.0.0

Supported

6.2.2

10.0.4

Tested

6.1.0

9.11.0

Supported, without @inherit

6.1.5

9.15.6

Tested

6.0.0

8.32.6

Supported, with the gaps listed below

6.0.15

9.13.3

Tested

5.2

Not supported
Tested

The integration test suite runs against the plone/plone-backend image of this release.

Supported

Every service plone-client uses is available.

Supported, with gaps

Everything works, except the services in the next table that the site’s plone.restapi does not have yet.

Not supported

plone-client is not tested against it, and nothing is done to keep it working.

Services that need a newer plone.restapi#

Every service plone-client uses exists in plone.restapi 8.32.6, which Plone 6.0.0 ships, except these. On an older site, the methods below raise PloneNotFoundError.

Service

plone.restapi

Methods

@relations

8.39.0

client.relations

@site

8.40.0

client.system.site()

@navroot

8.40.0

client.navigation.navroot()

GET @login

9.10.0

client.system.login_providers()

@inherit

9.13.0

client.navigation.inherit()

Logging in with POST @login works on every supported version.

Volto#

client.block_types, the block-types command, and the block_types tool of the MCP server ask the @blocks-schema service of the Volto server. That service comes with Volto pull request 8023, which is not part of a Volto release yet. Until a site runs a Volto that has it, they describe Volto’s core blocks instead, as Block types explains.

Python#

plone-client needs Python 3.11 or later. The site’s own Python version does not matter.

Converting Markdown and HTML to blocks, with the markdown extra, needs Python 3.12 or later, because collective.html2blocks does. On Python 3.11, the extra installs nothing, and the conversion raises PloneConfigurationError.

Contents