Skip to main content

CKAN Geospatial ResourceView

Project description

This extension contains view plugins to display geospatial files and services in CKAN. It contains an OpenLayers based viewer originally developed by Philippe Duchesne and other view plugins that used to be part of ckanext-spatial.

Note: This is a work in progress, if you can help with OpenLayers or Leaflet development, check the Issues section for what needs to be done or add a new issue.

Installation

To install ckanext-geoview on a production site:

  1. Activate your CKAN virtual environment, for example:

    source /usr/lib/ckan/default/bin/activate
  2. Install the ckanext-geoview Python package into your virtual environment:

    pip install ckanext-geoview
  3. Add the relevant plugins to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini). Check Available plugins to see which ones are available and if they require further configuration.

  4. Add the resource_proxy plugin to the ckan.plugins setting.

  5. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Development Installation

To install ckanext-geoview for development, activate your CKAN virtualenv and do:

git clone https://github.com/ckan/ckanext-geoview.git
cd ckanext-geoview
python setup.py develop

Available plugins

OpenLayers Viewer

http://i.imgur.com/wCQm2Uh.jpg

The OpenLayers viewer provides access to different geospatial formats and services:

To enable it, add geo_view to your ckan.plugins setting. (use geo_preview if you are using CKAN < 2.3):

ckan.plugins = ... resource_proxy geo_view

On CKAN >= 2.3, if you want the geospatial views to be created by default, add the plugin to the following setting:

ckan.views.default_views = ... geo_view

The formats and services supported are:

Type

Resource format (*)

Web Map Service (WMS)

wms

Web Feature Service (WFS)

wfs

GeoJSON

geojson

GML

gml

KML

kml

ArcGIS REST API

arcgis_rest

Google Fusion Tables

gft

(*) Resource formats are case insensitive

Support varies across formats, so you might want to deactivate the ones you are not interested in. To choose which formats to display, set the following configuration option:

ckanext.geoview.ol_viewer.formats = wms kml

To render Google Fusion Tables resources, a Google API Key must be provided in the ini file:

ckanext.geoview.gapi_key = <API Key here>

This key must be granted Fusion Tables permissions. More information on obtaining such a key can be found at https://developers.google.com/fusiontables/docs/v1/using#APIKey.

All configuration options relating to the OpenLayers viewer (ie those prefixed with ckanext.geoview.ol_viewer.*) are passed to the JavaScript module, where they are accessible on the options.ol_config object:

this.ckan.module('olpreview', function (jQuery, _) {

    // ...

    _onReady: function () {


        console.log(this.options.ol_config)

    }

    // ...

}

Other available configuration options are:

  • ckanext.geoview.ol_viewer.hide_overlays: if set to True, overlays won’t be visible by default (only the base layer)

Leaflet GeoJSON Viewer

Note: This plugin used to be part of ckanext-spatial.

http://i.imgur.com/4w9du2T.png

The Leaflet GeoJSON viewer will render GeoJSON files on a map and add a popup showing the features properties, for those resources that have a geojson format.

To enable it, add geojson_view to your ckan.plugins setting. (use geojson_preview if you are using CKAN < 2.3):

ckan.plugins = ... resource_proxy geojson_view

On CKAN >= 2.3, if you want the views to be created by default on all GeoJSON files, add the plugin to the following setting:

ckan.views.default_views = ... geojson_view

Leaflet WMTS Viewer

http://i.imgur.com/MderhVH.png

The Leaflet WMTS viewer will render WMTS (Web Map Tile Service) layers on a map for those resources that have a wmts format.

To enable it, add wmts_view to your ckan.plugins setting. (use wmts_preview if you are using CKAN < 2.3):

ckan.plugins = ... resource_proxy wmts_view

On CKAN >= 2.3, if you want the views to be created by default on all WMTS resources, add the plugin to the following setting:

ckan.views.default_views = ... wmts_view

Common base layers for Map Widgets

The geospatial view plugins support the same base map configurations than the ckanext-spatial widgets.

Check the following page to learn how to choose a different base map layer (MapQuest Open, MapBox or custom):

http://docs.ckan.org/projects/ckanext-spatial/en/latest/map-widgets.html

http://i.imgur.com/cdiIjkU.png

Registering ckanext-geoview on PyPI

ckanext-geoview should be availabe on PyPI as https://pypi-hypernode.com/pypi/ckanext-geoview. If that link doesn’t work, then you can register the project on PyPI for the first time by following these steps:

  1. Create a source distribution of the project:

    python setup.py sdist
  2. Register the project:

    python setup.py register
  3. Upload the source distribution to PyPI:

    python setup.py sdist upload
  4. Tag the first release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:

    git tag 0.0.1
    git push --tags

Releasing a new version of ckanext-geoview

ckanext-geoview is availabe on PyPI as https://pypi-hypernode.com/pypi/ckanext-geoview. To publish a new version to PyPI follow these steps:

  1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

  2. Create a source distribution of the new version:

    python setup.py sdist
  3. Upload the source distribution to PyPI:

    python setup.py sdist upload
  4. Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.2 then do:

    git tag 0.0.2
    git push --tags

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext-geoview-0.0.8.tar.gz (1.8 MB view details)

Uploaded Source

File details

Details for the file ckanext-geoview-0.0.8.tar.gz.

File metadata

File hashes

Hashes for ckanext-geoview-0.0.8.tar.gz
Algorithm Hash digest
SHA256 5500c111bb97dcd7ff452fde1cc6c8907c594dcc2a99f66487849bc8f5feff36
MD5 6f2aa469dc64915cf4ba64d3f50c4d79
BLAKE2b-256 616c5144a3781dbd279be38c1b9d887f790c873be7e2056a09444362a752a2ef

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page