Extension Transmute


Extension Basics

Title
Transmute
Name
ckanext-transmute
Type
Public extension
Description
Data validation and conversion pipeline
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2024-10-30
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Pipeline for data validation and conversion using declarative schemas. Transforms data structures with type-based field definitions, validators, default values, field removal, and weighted field ordering. Features include inline schema support for ckanapi, JSON schema definitions with root types, field validators (tsm_concat, map_value, stop_on_empty, etc.), validate_missing for required fields, default and default_from for default values, post-fields for cleanup/removal, weight-based field processing order, named schemas for reusability, drop_unknown_fields option, and ckanext-scheming integration.

Version
1.8.0
Version release date
2024-10-30
Contact name
DataShades / Oleksandr Cherniavskyi
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: pip install ckanext-transmute, add ‘transmute’ to ckan.plugins. Dependencies: ckanext-scheming, typing-extensions. Schema structure: {root: ‘example’, types: {example: {fields: {field_name: {validators: [[validator_name, args…]], default: value, validate_missing: true/false, weight: N}}, post-fields: {field_name: {remove: true}}}}}. Validators: tsm_concat for string concatenation, map_value for value mapping, stop_on_empty to halt on empty values. Field processing: weight controls order (higher = later), post-fields for cleanup after validation. Use via API: ckanapi action tsm_transmute root=TYPE data:’{…}’ schema:’{…}’. Named schemas for reuse across transformations. drop_unknown_fields to remove undefined fields. Documentation: https://datashades.github.io/ckanext-transmute/. Use cases: Data import transformations, API response formatting, field mapping between systems, data cleanup pipelines.

Plugins to configure (ckan.ini)
transmute
CKAN Settings (ckan.ini)
(not set)
DB migration to be executed
(not set)
<< back to Extensions