Extension Custom Schema


Extension Basics

Title
Custom Schema
Name
ckanext-custom-schema
Type
Public extension
Description
Customizes dataset schema to add custom metadata fields. Requires ckanext-scheming extension.
CKAN versions
Download-Url (zip)
Last commit
a year ago (2025-01-22 19:53:43)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-custom-schema

A CKAN extension to customize datasets’ schema. By adding custom fields to the schema, this extension allows users to provide more information about datasets.

This extension adds customized metadata fields to datasets. After enabling it, go to ${URL}/dataset/edit/${YOUR-DATASET} to edit the custom fields.

Repo Structure

This is a mono-repo. Each branch contains a customer’s schema. Before doing any work, please make sure that you are on the right branch.

Dependencies

This extension is dependent on the ckanext-scheming extension. Install ckanext-scheming before installing this extension.

Installation

To install, activate your CKAN virtualenv, install dependencies, and install the module in develop mode:

. path/to/pyenv/bin/activate
pip install -r requirements.txt
python setup.py develop

Then in your CKAN .ini file, add custom_schema to your ckan.plugins line. Note: The custom_schema extension needs to come before the scheming_datasets extension.

ckan.plugins = (other plugins) custom_schema scheming_datasets

License

AGPL-3.0

Version
0.1.0
Version release date
2024-01-29
Contact name
OpenGov
Contakt email
(not set)
Contact Url


Installation Guide

Configuration hints

Requires ckanext-scheming. Plugin must be loaded before scheming_datasets.

Plugins to configure (ckan.ini)
custom_schema
CKAN Settings (ckan.ini)
# No additional environment variables required
DB migration to be executed
(not set)
<< back to Extensions