Extension Toolbelt


Extension Basics

Title
Toolbelt
Name
ckanext-toolbelt
Type
Public extension
Description
Collection of utilities, decorators, and plugins for daily CKAN development tasks.
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2025-08-01
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

Comprehensive utility collection for CKAN developers. Includes decorators like Collector (for organizing actions, validators, helpers) and Cache (Redis-based function caching). Provides multiple plugins: toolbelt_fdt_sqlalchemy (Flask-SQLAlchemy adapter), toolbelt_cascade_organization_updates (reindex datasets on org update), toolbelt_composite_groups/organizations (repeating subfields support). Features extensive CLI tools via ‘ckan toolbelt’ for generating extensions (make ckanext), configs (make config), templates, GitHub actions, and README sections. Includes pytest-toolbelt fixtures for testing. No database migrations required.

Version
v0.6.7
Version release date
2025-08-01
Contact name
DataShades
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

CLI available without adding to ckan.plugins via ‘ckan toolbelt’ or global ‘ctb’ command. Plugins can be enabled individually as needed. toolbelt_fdt_sqlalchemy requires flask-sqlalchemy extra: pip install ‘ckanext-toolbelt[flask-sqlalchemy]’. toolbelt_cascade_organization_updates requires background worker. CLI commands include: ‘make ckanext’ (create extension), ‘make config’ (deps-makefile, pre-commit, pyproject, gulp-sass), ‘make gh-action’ (pypi-publish, release-please, test), ‘make readme config’, ‘dev mail-server’, ‘search-index clear-missing’, ‘db clean’. Decorators available in ckanext.toolbelt.decorators. Utility modules in ckanext.toolbelt.utils (cache, fs, scheming, structures, hierarchy).

Plugins to configure (ckan.ini)
toolbelt_fdt_sqlalchemy toolbelt_cascade_organization_updates toolbelt_composite_groups toolbelt_composite_organizations group_changes
CKAN Settings (ckan.ini)
# No specific environment variables required # Most functionality available via CLI without configuration # Optional: Redis for Cache decorator # ckan.redis.url = redis://localhost:6379/0 # Plugin-specific configs # toolbelt.cascade_organization_updates.enabled = true
DB migration to be executed
(not set)
<< back to Extensions