search

koopjs / koop-provider-ckan

CKAN provider for Koop (experimental).
Other
4 stars 5 forks source link
koop-provider

readme

koop-ckan

CKAN Provider for Koop

npm version build status Greenkeeper badge

Install

To use this provider you first need a working installation of Koop. Then from within the koop directory you'll need to run the following:

npm install koop-ckan --save

Usage

Registering CKAN Hosts

Once this provider's been installed you need to register a particular instance of CKAN with your Koop instance. To do this you need to make a POST request to the /ckan endpoint like so:

curl --data "host=https://data.nola.gov&id=nola" localhost:1337/ckan

For Windows users, download cURL from http://curl.haxx.se/download.html or use a tool of your choice to generate the POST request.

What you'll need for that request to work is an ID for koop to use as a reference and the URL of the CKAN instance. The ID is what you'll use to reference datasets that come from CKAN in Koop.

To make sure this works you can visit http://localhost:1337/ckan and you should see all of the registered hosts.

Access CKAN Data

To access a dataset hosted in CKAN you'll need a "dataset id" from CKAN which could be referenced in Koop like so:

http://koop.dc.esri.com/ckan/rwlabs/ourairports-ind

Examples

Here's a few examples of data hosted in CKAN and accessed via Koop

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

License

Apache 2.0