ckanext-opensearch
ckanext-opensearch adds an OpenSearch interface to CKAN.
This extension adds three endpoints to a CKAN portal:
opensearch/description.xml? — The endpoint for accessing the description document that describes the parameters accepted by the search endpoints.
opensearch/search.atom? — Dataset-level search returning Atom feed results.
opensearch/collection_search.atom? — Collection-level search for two-step searching.
The extension supports two-step search (collection-level then dataset-level), which is common in the Earth Observation community. Collection search groups datasets by collection_id, and users can then drill down into specific collections.
The extension uses TOML files to specify collections and parameters, and Jinja2 templates for generating XML description documents and Atom feed results.
Default search parameters include: opensearch:searchTerms, opensearch:maxResults, opensearch:startPage, geo:box, geo:uid, time:start, time:end, eo:modificationDate, geo:geometry.
Developed for the NextGEOSS project but aims to be a fully generalized extension for OpenSearch in CKAN. Compliant with OGC OpenSearch best practices. 34 releases available.
Installation
- Activate your CKAN virtual environment.
- Install the extension.
- Add
opensearch to the ckan.plugins setting in your CKAN config file.
- Restart CKAN.
Configuration
The extension uses TOML configuration files:
- collections_list.toml
- dataset_parameters.toml
- collection_parameters.toml
- namespaces.toml
License
AGPL-3.0