Extension Dataset Search Autocomplete


Extension Basics

Title
Dataset Search Autocomplete
Name
ckanext-search-autocomplete
Type
Public extension
Description
Autocomplete functionality for dataset search with configurable facets
CKAN versions
Download-Url (zip)
Download-Url commit date
2021-08-02
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

Provides intelligent autocomplete functionality for the CKAN dataset search interface (/datasets page). The extension searches across dataset titles and configurable facets to provide real-time suggestions as users type. Default facets include organizations, tags, and resource formats, but these can be customized through the ISearchAutocomplete interface to match specific site requirements. The autocomplete limit, implementation templates, and search endpoints are fully configurable, allowing adaptation to different CKAN package types and search patterns. Compatible with CKAN 2.9-2.10 and provides a clean interface for extending search behavior.

Version
0.1.0
Version release date
2021-08-02
Contact name
Alexandr Cherniavskyi
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: git clone repository, pip install -e ., pip install -r requirements.txt. Add ‘search_autocomplete’ to ckan.plugins in your CKAN configuration. Default Facets: organization ((‘Organisations’)), tags ((‘Tags’)), res_format (_(‘Formats’)) - searches across dataset titles and these facets. ISearchAutocomplete Interface: Implement this interface to redefine facets for autocomplete customization. Configuration Options: ckanext.search_autocomplete.autocomplete_limit = 10 (default: 6) - number of autocomplete items to display. ckanext.search_autocomplete.enable_default_implementation = yes (default: false) - enables basic template implementation for testing. ckanext.search_autocomplete.dataset_search_endpoints = dataset.search custom_dataset_type.search (default: dataset.search group.read organization.read) - Flask endpoints where autocomplete is active. Development: pytest for testing. Compatible with CKAN 2.9-2.10, Python 2.7 supported.

Plugins to configure (ckan.ini)
search_autocomplete
CKAN Settings (ckan.ini)
# ckanext.search_autocomplete.autocomplete_limit = 10
DB migration to be executed
(not set)
<< back to Extensions