Changelog

Changelog#

1.0.0a1 (2026-10-27)#

Breaking changes:#

  • Rewrote the client on httpx: one PloneClient per site, with the managers as attributes and paths, site URLs, uid:<UID> and resolveuid links accepted wherever an item is expected. AsyncPloneClient, PloneClientConfig and the methods for services that plone.restapi does not provide were removed, and Python 3.11 is now the minimum. @ericof

New features:#

  • Added plone_client.operations, tasks that send several requests in the right order: create an item with files and images inside it and set its lead image, create a page from Markdown or HTML, upload a local folder keeping its structure, and copy or move items with a report. Each operation honors dry_run and read_only, returns every request it sent, and raises PloneOperationError with what was already created when it stops part way. The commands create-page, create-with-files, and upload-tree run them from the command line. @ericof #9

  • Added an MCP server, plone-client mcp, in the new mcp extra: it serves the selected profile over standard input and output, or several sites at once with --site, --group, or --all, offering the everyday reads, the high-level operations, and one tool for any other plone.restapi service; changes to read-only profiles are refused. Profiles can now be gathered into named groups in the configuration file, managed with plone-client profile groups, group-set, and group-remove. @ericof #9

  • Added blocks.block, blocks.container, blocks.grid, and blocks.teaser, to build blocks of any type, including add-on blocks and blocks that hold others, such as a grid of four teasers. blocks.text now builds its paragraph with collective.html2blocks when the markdown extra is installed, and collapses runs of whitespace either way. @ericof #9

  • Added client.block_types and the block-types command, which list the blocks of a Volto site and describe their data from the @blocks-schema service of the Volto server, reached through the new frontend_url setting. Sites without that service get the documentation of Volto’s core blocks instead. The new markdown extra converts Markdown and HTML to blocks with collective.html2blocks, on Python 3.12 or later. @ericof #9

  • Added plone_client.blocks, helpers to build Volto blocks and to walk them and their links. @ericof

  • Added read_only and dry_run modes to PloneClient, so a script can refuse or preview every change it would make to a site. @ericof

  • Added an agent skill that teaches coding agents such as Claude Code to work with Plone sites through the command line, installed with plone-client skill install. @ericof

  • Added named connection profiles to work with several sites, with passwords kept in the operating system keyring, an environment variable or a command such as a password manager, read-only profiles, a .plone-client.toml file that selects the profile of a project, and timeout, retry, and TLS settings per profile or shared by all of them, including a custom CA bundle. @ericof

  • Added the plone-client command line, installed with the cli extra: read, search, create, change, publish, move, upload and download content, and manage users, groups, the registry and aliases, with JSON output and exit codes meant for scripts and agents. @ericof

  • Grouped the command line help into panels: commands that read, change, or upload content, site administration, advanced requests, and configuration; each command group splits its subcommands into Browse and Write panels. In a terminal the panels are drawn as boxes; when the output goes to a pipe or a file, as for coding agents, the help is plain text with the same groups. @ericof

Bug fixes:#

  • Fixed the requests for copying, moving and ordering content, changing the registry, group membership, undoing transactions and uploading files with TUS, which did not match what plone.restapi expects. @ericof

Internal:#

  • Added a make release command that releases the package with zest.releaser and publishes it with uv. @ericof

  • Licensed the package under the GPLv2, like Plone. @ericof

  • Moved continuous integration and linting to uv and make targets, and added the towncrier change log check and Dependabot. @ericof

  • Updated locked dependencies with security fixes: anyio, certifi, idna, Pygments, requests, soupsieve, and urllib3. @ericof

Documentation:#

  • Documented the MCP server, the high-level operations, and the block types: how to connect an assistant, how to create content in one step, how to build any block, a reference of the MCP tools, and an explanation of when to use the MCP server, the command line, or the agent skill. @ericof #9

  • Fixed the links to the plone.restapi documentation. @ericof

  • Rewrote the documentation following the Plone documentation style and the Diátaxis framework, with the Plone Sphinx theme: tutorials, how-to guides with runnable examples, reference including a compatibility grid with Plone and plone.restapi versions and a map to the functions of @plone/client, and explanation. @ericof

Tests#

  • Added unit tests that check every request against the plone.restapi documentation, and integration tests against Plone 6.0, 6.1, and 6.2 in Docker. @ericof

  • Fixed the agent skill tests on Windows, where paths use backslashes and the home directory comes from USERPROFILE. @ericof

Contents