Extension ESD Standards


Extension Basics

Title
ESD Standards
Name
ckanext-esdstandards
Type
Public extension
Description
Helpers for working with LGA's ESD standards on CKAN, providing action functions for autocomplete lookup, form widgets, and validators for ESD Functions and Services fields.
CKAN versions
Download-Url (zip)
Last commit
10 years ago (2015-03-18 09:45:52)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-esdstandards

Helpers for working with LGA’s ESD standards on CKAN.

This extension contains:

  • Action functions for autocomplete lookup for ESD Functions and Services
  • Form widgets and validators for easily integrate ESD Functions and Services fields into custom schemas (adding the la_function and la_service fields, supported when harvesting datasets into data.gov.uk)
  • Snippets for rendering the ESD Functions and Services on the dataset page

Installation

To install ckanext-esdstandards:

  1. Activate your CKAN virtual environment:

    source /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-esdstandards Python package:

    pip install ckanext-esdstandards
    
  3. Add esd to the ckan.plugins setting in your CKAN config file.

  4. Restart CKAN.

Integrating on Your Own Extension

This extension will not add anything by default to your CKAN instance (apart from some helper actions and functions). You need to modify the schema and templates on your project extension to add the fields and widgets.

Adding Fields to Custom Schema

You will need to extend the default CKAN schema using the IDatasetForm interface. The extension provides validators: - esd_function_validator - esd_service_validator

The fields should be stored as extras named la_function and la_service (as per Appendix B of the data.gov.uk harvesting guide).

Adding Form Widgets

Extend the package_basic_fields.html template with the provided snippets: - snippets/esd_functions.html - snippets/esd_services.html

Displaying Field Values

Extend the additional_info.html template with: - snippets/esd_functions_additional_info.html - snippets/esd_services_additional_info.html

Development Installation

git clone https://github.com/okfn/ckanext-esdstandards.git
cd ckanext-esdstandards
python setup.py develop

License

Available on PyPI as ckanext-esdstandards

Version
0.0.4
Version release date
2015-03-18
Contact name
Open Knowledge Foundation
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Add ‘esd’ to ckan.plugins. Requires custom schema and template integration in your own extension. Used for data.gov.uk harvesting compliance. Available on PyPI.

Plugins to configure (ckan.ini)
esd
CKAN Settings (ckan.ini)
# No specific configuration options documented
DB migration to be executed
(not set)
<< back to Extensions