CFPB CKAN Extra Fields

Description: This is a CKAN extension to add CFPB-specific extra metadata fields. It is a sibling project to https://github.com/cfpb/ckan-installer and expected to live along-side that project.

Dependencies

General

• Python 2.7
• virtualenv and virtualenvwrapper
• Vagrant for local testing

Runtime

This is a CKAN extension designed to plug in to a running instance of CKAN. For local testing, we use Vagrant. See https://github.com/cfpb/ckan-installer for details.

Testing

For running unit tests:

1. git clone this repository and cd into it
2. create a new virtualenv: mkvirtualenv ckanext-cfpb-extrafields
3. install requirements: pip install -r requirements-test.txt

Installation

This software should live alongside a cloned copy of https://github.com/cfpb/ckan-installer. That project's provisioning will create a mapped directory in the Vagrant install.

For real servers, this software should be installed via pip install

How to test the software

After following the testing installation instructions above, you can test with:

nosetests -s --with-coverage --cover-package=ckanext.cfpb_extrafields.validators

Getting help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

Getting involved

See CONTRIBUTING.

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy

Credits and references

1. http://docs.ckan.org/en/latest/extensions/index.html