Package: ckanext-datajson
ckanext-datajsonA CKAN extension containing pluginsdatajson.
First is used byhttp://catalog.data.gov/to harvest data sources
from a remote /data.json file according to the U.S. Project
Open Data metadata specification (https://resources.data.gov/schemas/dcat-us/v1.1/).Plugindatajsonprovides a harvester to import datasets from other
remote /data.json files. See below for setup instructions.And the plugin also provides a new view to validate /data.json files
athttp://ckanhostname/dcat-us/validator.Features[:heavy_check_mark:]datajsonprovides data.json export and DCAT-US metadata UI integrationRead more aboutdatajson[:heavy_check_mark:]datajson_harvestextendsckanext-harvestto collect metadata fromremote data.json sourcesRead more aboutdatajson_harvest[:warning:]cmsdatanav_harvestextendsckanext-harvestto collect metadata from for the CMS Data Navigator catalog[:heavy_check_mark:]datajson_validatorprovides a web form to validate dcat-us metadata data.json compliance.Read more aboutdatajson_validatorUsageRequirementsAll requirements are trackedsetup.pywhen possible.  Some CKAN extensions are not on PyPI, so they
(and their dependencies) must be tracked inrequirements.txt.ckanext-harvestCKAN versionCompatibility<=2.7:x:2.8:warning:2.9.5:heavy_check_mark:2.9.6:heavy_check_mark:InstallationTo install, activate your CKAN virtualenv, install dependencies, and
install the module in develop mode, which just puts the directory in your
Python path.. path/to/pyenv/bin/activate
pip install -r requirements.txt
python setup.py developThen in your CKAN .ini file, adddatajsonto your ckan.plugins line:ckan.plugins = (other plugins here...) datajsonThat's the plugin for /data.json output. To make the harvester available,
also add:ckan.plugins = (other plugins here...) harvest datajson_harvestTo make the datajson validator route and web form available, also add:ckan.plugins = (other plugins here...) datajson_validatorDevelopmentSetupBuild the docker containers.$ make buildStart the docker containers.$ make upCKAN will start atlocalhost:5000.Clean up any containers and volumes.$ make cleanOpen a shell to run commands in the container.$ docker-compose exec app /bin/bashIf you're unfamiliar with docker-compose, see ourcheatsheetand theofficial docs.For additional make targets, see the help.$ make helpTestingThey follow the guidelines fortesting CKAN
extensions.To run the extension tests, start the containers withmake up, then:$ make testLint the code.$ make lintMatrix buildsThe test development environment drops as many dependencies as possible. It is
not meant to have feature parity withGSA/catalog.data.gov. Tests should
mock external dependencies where possible.In order to support multiple versions of CKAN, or even upgrade to new versions
of CKAN, we support development and testing through theCKAN_VERSIONenvironment variable.$ make CKAN_VERSION=2.9.5 test
$ make CKAN_VERSION=2.9 testNote: When testing patch versions of CKAN, the services may not have patch releases.
So, take note of theSERVICES_VERSIONvariable which tracks the minor release to
pull for thedbandsolrimages.Credit / CopyingOriginal work written by the HealthData.gov team. It has been modified in support of Data.gov.As a work of the United States Government, this package is in the public
domain within the United States. Additionally, we waive copyright and
related rights in the work worldwide through the CC0 1.0 Universal
public domain dedication (which can be found athttp://creativecommons.org/publicdomain/zero/1.0/).Ways to ContributeWe're so glad you're thinking about contributing to ckanext-datajson!Before contributing to ckanext-datajson we encourage you to read ourCONTRIBUTINGguide, ourLICENSE, and our README
(you are here), all of which should be in this repository. If you have any
questions, you can email the Data.gov team atdatagov@gsa.gov.