ckanext-composite-search


Nameckanext-composite-search JSON
Version 0.3.3 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-11-11 12:26:42
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseAGPL
keywords ckan
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![Tests](https://github.com/DataShades/ckanext-composite-search/workflows/Tests/badge.svg?branch=main)](https://github.com/DataShades/ckanext-composite-search/actions)

# ckanext-composite-search

Complex search form for the dataset search page.

Filter by field, search by multiple criteria, combine filter with the AND/OR operators and
forget about Lucene queries

## Requirements

Compatibility with core CKAN versions:

| CKAN version    | Compatible? |
|-----------------|-------------|
| 2.9             | yes         |
| 2.10            | yes         |
|                 |             |


## Installation

To install ckanext-composite-search:

1. Install the extension
     ```sh
	pip install ckanext-composite-search
     ```

1. Add `composite_search default_composite_search` to the `ckan.plugins`
   setting in your CKAN config file.


## Config settings


```ini
# Prefix for field-names of the search form. Due to the way,
# CKAN handles extra search parameters, prefix must begin with `ext_`
# (optional, default: ext_composite_).
ckanext.composite_search.prefix = ext_p_

# Escape search terms using single-quote, double-quote or both at the same time.
# (optional, default: double, values: single|double|both).
ckanext.composite_search.plugin.default.literal_quotes = single

# List of field names that must not be tokenized. Usually, one will
# use this option when searching by tags or other keywords.
# (optional, default: <empty>).
ckanext.composite_search.plugin.default.keyword_fields = tags groups

```

## License

[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ckanext-composite-search",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "DataShades <datashades@linkdigital.com.au>",
    "keywords": "CKAN",
    "author": null,
    "author_email": "DataShades <datashades@linkdigital.com.au>, Sergey Motornyuk <sergey.motornyuk@linkdigital.com.au>",
    "download_url": "https://files.pythonhosted.org/packages/50/55/625ce2e5c40b7623a0a96711db8c357d299a56464df69df0edef3714b071/ckanext_composite_search-0.3.3.tar.gz",
    "platform": null,
    "description": "[![Tests](https://github.com/DataShades/ckanext-composite-search/workflows/Tests/badge.svg?branch=main)](https://github.com/DataShades/ckanext-composite-search/actions)\n\n# ckanext-composite-search\n\nComplex search form for the dataset search page.\n\nFilter by field, search by multiple criteria, combine filter with the AND/OR operators and\nforget about Lucene queries\n\n## Requirements\n\nCompatibility with core CKAN versions:\n\n| CKAN version    | Compatible? |\n|-----------------|-------------|\n| 2.9             | yes         |\n| 2.10            | yes         |\n|                 |             |\n\n\n## Installation\n\nTo install ckanext-composite-search:\n\n1. Install the extension\n     ```sh\n\tpip install ckanext-composite-search\n     ```\n\n1. Add `composite_search default_composite_search` to the `ckan.plugins`\n   setting in your CKAN config file.\n\n\n## Config settings\n\n\n```ini\n# Prefix for field-names of the search form. Due to the way,\n# CKAN handles extra search parameters, prefix must begin with `ext_`\n# (optional, default: ext_composite_).\nckanext.composite_search.prefix = ext_p_\n\n# Escape search terms using single-quote, double-quote or both at the same time.\n# (optional, default: double, values: single|double|both).\nckanext.composite_search.plugin.default.literal_quotes = single\n\n# List of field names that must not be tokenized. Usually, one will\n# use this option when searching by tags or other keywords.\n# (optional, default: <empty>).\nckanext.composite_search.plugin.default.keyword_fields = tags groups\n\n```\n\n## License\n\n[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)\n",
    "bugtrack_url": null,
    "license": "AGPL",
    "summary": null,
    "version": "0.3.3",
    "project_urls": {
        "Homepage": "https://github.com/DataShades/ckanext-composite-search"
    },
    "split_keywords": [
        "ckan"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45bacb45afa6f446cb83dd454ff81b1e25a9db937814ae86807539241cc13da4",
                "md5": "fdda076cb165254a773bcacbd1b450c2",
                "sha256": "86a94c608c9a1b0286664fa7d4c40e9a77f5ebae2979075029c4db5758988a19"
            },
            "downloads": -1,
            "filename": "ckanext_composite_search-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fdda076cb165254a773bcacbd1b450c2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 40522,
            "upload_time": "2024-11-11T12:26:40",
            "upload_time_iso_8601": "2024-11-11T12:26:40.780168Z",
            "url": "https://files.pythonhosted.org/packages/45/ba/cb45afa6f446cb83dd454ff81b1e25a9db937814ae86807539241cc13da4/ckanext_composite_search-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5055625ce2e5c40b7623a0a96711db8c357d299a56464df69df0edef3714b071",
                "md5": "961a7f913a72b274876704267b6fa173",
                "sha256": "99cee511b74854c698429bffd6ff9eba64cc4370ce69b545b6862b967a420470"
            },
            "downloads": -1,
            "filename": "ckanext_composite_search-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "961a7f913a72b274876704267b6fa173",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 38850,
            "upload_time": "2024-11-11T12:26:42",
            "upload_time_iso_8601": "2024-11-11T12:26:42.339455Z",
            "url": "https://files.pythonhosted.org/packages/50/55/625ce2e5c40b7623a0a96711db8c357d299a56464df69df0edef3714b071/ckanext_composite_search-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-11 12:26:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DataShades",
    "github_project": "ckanext-composite-search",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "ckanext-composite-search"
}
        
Elapsed time: 0.40930s