Extension US Metadata


Extension Basics

Title
US Metadata
Name
ckanext-usmetadata
Type
Public extension
Description
Expands CKAN to offer custom fields related to the DCAT-US Schema for inventory.data.gov.
CKAN versions

~2.10

Show details
Download-Url (zip)
Last commit
a year ago (2025-01-30 17:00:26)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-usmetadata

This CKAN Extension expands CKAN to offer a number of custom fields related to the DCAT-US Schema (https://resources.data.gov/schemas/dcat-us/v1.1/).

Installation

Add ckanext-usmetadata to your requirements.txt, and then pip install.

Then in your CKAN .ini file, add usmetadata to your ckan.plugins line:

ckan.plugins = (other plugins here...) usmetadata

Requirements

This extension is compatible with these versions of CKAN:

CKAN version Compatible?
<=2.9 no
2.10 yes

Development

You may also install by cloning the git repo, then running python setup.py develop from the root of your source directory, which will install an egg link so that you can modify the code and see results.

Clean up any containers and volumes:

$ make down

Open a shell to run commands in the container:

$ docker-compose exec ckan bash

Testing

They follow the guidelines for testing CKAN extensions.

To run the extension tests, start the containers with make up, then:

$ make test

Lint the code:

$ make lint

Matrix builds

In order to support multiple versions of CKAN, or even upgrade to new versions of CKAN, we support development and testing through the CKAN_VERSION environment variable.

$ make CKAN_VERSION=2.9 test

Credit / Copying

Credit to the original owner of the repo. Everything here is built on top of the original foundation.

Version
1.16
Version release date
2014-03-28
Contact name
U.S. General Services Administration
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Only compatible with CKAN 2.10+. Not compatible with CKAN 2.9 or earlier.

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