[](https://github.com/mutantsan/ckanext-search-autocomplete/actions)
# ckanext-search-autocomplete
This extension provides an autocomplete for /datasets page search.
Autocomplete search by dataset titles and facets.
The default facets:
```
{
'organization': _('Organisations'),
'tags': ('Tags'),
'res_format': _('Formats'),
}
```
You can redefine this by implementing the ISearchAutocomplete interface.
## Requirements
Compatibility with core CKAN versions:
| CKAN version | Compatible? |
|-----------------|-------------|
| 2.6 and earlier | not tested |
| 2.7 | not tested |
| 2.8 | not tested |
| 2.9 | yes |
| 2.10 | yes |
## Installation
To install ckanext-search-autocomplete:
1. Clone the source and install it on the virtualenv
git clone https://github.com/mutantsan/ckanext-search-autocomplete.git
cd ckanext-search-autocomplete
pip install -e .
pip install -r requirements.txt
2. Add `search_autocomplete` to the `ckan.plugins` setting in your CKAN
config file.
## Config settings
TODO:
# The item limit to show
# (optional, default: 6).
ckanext.search_autocomplete.autocomplete_limit = 10
# Enable basic(example) template with the autocomplete widget.
# You can use it for testing, but it's better to implement your own template,
# because basic one is neither configurable, nor fancy-looking
# (optional, default: false).
ckanext.search_autocomplete.enable_default_implementation = yes
# Space-separated list of CKAN endpoints(Flask endpoints in form `blueprint.view`).
# It can be used if you want to enable autocomplete for non-standard dataset types, or on
# the organization/group page.
# (optional, default: dataset.search group.read organization.read).
ckanext.search_autocomplete.dataset_search_endpoints = dataset.search custom_dataset_type.search
## Developer installation
To install ckanext-search-autocomplete for development, activate your CKAN virtualenv and
do:
git clone https://github.com/mutantsan/ckanext-search-autocomplete.git
cd ckanext-search-autocomplete
python setup.py develop
pip install -r dev-requirements.txt
## Tests
To run the tests, do:
pytest --ckan-ini=test.ini
## License
[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)
Raw data
{
"_id": null,
"home_page": "https://github.com/mutantsan/ckanext-search-autocomplete",
"name": "ckanext-search-autocomplete",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "CKAN",
"author": "Alexandr Cherniavskyi",
"author_email": "mutantsan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/54/fa/c890cdf873518ea312c5c92e3be79a5062bdcdc2425ff30d9411c735b3ae/ckanext_search_autocomplete-0.1.0.tar.gz",
"platform": null,
"description": "[](https://github.com/mutantsan/ckanext-search-autocomplete/actions)\n\n# ckanext-search-autocomplete\n\nThis extension provides an autocomplete for /datasets page search.\nAutocomplete search by dataset titles and facets.\n\nThe default facets:\n```\n{\n 'organization': _('Organisations'),\n 'tags': ('Tags'),\n 'res_format': _('Formats'),\n}\n```\n\nYou can redefine this by implementing the ISearchAutocomplete interface.\n\n\n## Requirements\n\nCompatibility with core CKAN versions:\n\n| CKAN version | Compatible? |\n|-----------------|-------------|\n| 2.6 and earlier | not tested |\n| 2.7 | not tested |\n| 2.8 | not tested |\n| 2.9 | yes |\n| 2.10 | yes |\n\n## Installation\n\nTo install ckanext-search-autocomplete:\n\n1. Clone the source and install it on the virtualenv\n\n git clone https://github.com/mutantsan/ckanext-search-autocomplete.git\n cd ckanext-search-autocomplete\n pip install -e .\n\tpip install -r requirements.txt\n\n2. Add `search_autocomplete` to the `ckan.plugins` setting in your CKAN\n config file.\n\n\n## Config settings\nTODO:\n\n\t# The item limit to show\n\t# (optional, default: 6).\n\tckanext.search_autocomplete.autocomplete_limit = 10\n\n\n\t# Enable basic(example) template with the autocomplete widget.\n # You can use it for testing, but it's better to implement your own template,\n # because basic one is neither configurable, nor fancy-looking\n\t# (optional, default: false).\n\tckanext.search_autocomplete.enable_default_implementation = yes\n\n\t# Space-separated list of CKAN endpoints(Flask endpoints in form `blueprint.view`).\n # It can be used if you want to enable autocomplete for non-standard dataset types, or on\n # the organization/group page.\n\t# (optional, default: dataset.search group.read organization.read).\n\tckanext.search_autocomplete.dataset_search_endpoints = dataset.search custom_dataset_type.search\n\n## Developer installation\n\nTo install ckanext-search-autocomplete for development, activate your CKAN virtualenv and\ndo:\n\n git clone https://github.com/mutantsan/ckanext-search-autocomplete.git\n cd ckanext-search-autocomplete\n python setup.py develop\n pip install -r dev-requirements.txt\n\n\n## Tests\n\nTo run the tests, do:\n\n pytest --ckan-ini=test.ini\n\n## License\n\n[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": "Search autocompletion",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/mutantsan/ckanext-search-autocomplete"
},
"split_keywords": [
"ckan"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb9d3bf74e659bf688d9462d03cc3318f8c3a0cc67ab6e52348ea736c95b744a",
"md5": "f44015e57b2aaad3a4010b91896e765d",
"sha256": "20efac2e002e7d5b578bbbc8b6380f6d4b87155fa2a4a61ff50cf48be5a9b369"
},
"downloads": -1,
"filename": "ckanext_search_autocomplete-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f44015e57b2aaad3a4010b91896e765d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 25679,
"upload_time": "2024-10-14T09:04:35",
"upload_time_iso_8601": "2024-10-14T09:04:35.260959Z",
"url": "https://files.pythonhosted.org/packages/cb/9d/3bf74e659bf688d9462d03cc3318f8c3a0cc67ab6e52348ea736c95b744a/ckanext_search_autocomplete-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "54fac890cdf873518ea312c5c92e3be79a5062bdcdc2425ff30d9411c735b3ae",
"md5": "1908607e013c33cc1f701c20cdf95045",
"sha256": "904b149e524f6268cdc7546ad5092b4d27bf78845df82114bda51ad5b500d60b"
},
"downloads": -1,
"filename": "ckanext_search_autocomplete-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1908607e013c33cc1f701c20cdf95045",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24538,
"upload_time": "2024-10-14T09:04:37",
"upload_time_iso_8601": "2024-10-14T09:04:37.620870Z",
"url": "https://files.pythonhosted.org/packages/54/fa/c890cdf873518ea312c5c92e3be79a5062bdcdc2425ff30d9411c735b3ae/ckanext_search_autocomplete-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-14 09:04:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mutantsan",
"github_project": "ckanext-search-autocomplete",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "typing-extensions",
"specs": []
}
],
"lcname": "ckanext-search-autocomplete"
}
JSON
