The backend package for Keyword Manager for Plone — a Plone 6 add-on that lets content editors rename, merge, and delete keywords (subjects/tags) across a site, with all content updated automatically. See also the frontend package @kitconcept/volto-keywordmanager.

Features 🔥

• Browse all keywords currently in use, sorted by name or by number of occurrences.
• Filter keywords to quickly find a specific term in a long list.
• Rename a keyword — the new name is applied to every content item that uses it automatically.
• Merge keywords — combine synonyms, fix typos, or resolve ambiguities by merging multiple keywords into one canonical term; all affected content is updated in one step.
• Delete keywords — remove terms that are no longer needed.
• Manage multiple keyword fields — works with the standard Subject field and any other keyword-type index in the catalog.

Requirements

• Plone 6.1 or 6.2
• Python 3.11, 3.12, or 3.13

Installation 🔧

Install kitconcept.keywordmanager with uv.

uv add kitconcept.keywordmanager

Create the Plone site.

make create-site

Configuration

This package allows for some configuration.

To configure one of the following options, import the config module like so:

from kitconcept.keywordmanager import config

Options

The keywords permission allows you to set a custom permission who should be able to manage keywords.

config.MANAGE_KEYWORDS_PERMISSION = "kitconcept.keywordmanager: Manage Keywords"

The meta type of the keyword indexes can be set. This is only useful if you're one of those crazy people that use custom indexes.

config.META_TYPE = "KeywordIndex"

There are indexes of META_TYPE we know we don't want to manage because bad things will happen. You can exclude those using:

config.IGNORE_INDEXES = [
    "object_provides",
    "allowedRolesAndUsers",
    "getRawRelatedItems",
    "getEventType",
    "block_types",
]

You can set a list of indexes that should always be reindex when merging or deleting keywords on objects. Most people won't need this.

config.ALWAYS_REINDEX = ("SearchableText",)

REST API

GET /@keywords (or /path/to/page/@keywords)

PATCH /@keywords (or /path/to/page/@keywords)

DELETE /@keywords (or /path/to/page/@keywords)

GET /@keywordIndex

No parameters.

Utility

Getting the utility.

from kitconcept.keywordmanager.interfaces import IKeywordManager
from zope.component import getUtility

km = getUtility(IKeywordManager)

Contributing 🐛

• Issue tracker
• Source code

Prerequisites ✅

• An operating system that runs all the requirements mentioned.
• uv
• Make
• Git
• Docker (optional)

Installation 🔧

1. Clone this repository.

   git clone git@github.com:kitconcept/kitconcept-keywordmanager.git
   cd kitconcept-keywordmanager/backend
   

2. Install this code base.

   make install
   

License

The project is licensed under GPLv2.

Credits and acknowledgements 🙏

Generated using Cookieplone (2.0.0a3) and cookieplone-templates (cda10db) on 2026-05-29 11:44:37.855709. A special thanks to all contributors and supporters!