Toolkit for Elasticsearch Synonym files.
Project description
![Elasticsearch Synonyms](docs/banner.png)
[![Build Status][travis-img-url]][travis-href]
This repository contains a curated dataset of synonyms in [Solr Format][1]. These
synonyms can be used for [Elasticsearch Synonym Token Filter][2] configuration.
Additional helper tools in this repository:
- `synlint`: Commandline tool to lint and validate the synonym files.
- `synonyms.sublime-syntax`: Syntax highlighting file for Sublime Text 3.
## Datasets
Following datasets are currently available:
- `be-ae`: British English and American English Spellings. From [AVKO.org](https://to.noop.pw/2sNor7C).
## Usage
- The synonym files in `data/` can be used directly in configuration.
- To use the linter tool, install python dependencies from `requirements.txt` and use:
```shell
python -m synlint [file names]
```
- To run tests:
```shell
./panda test:all
```
## License
The tools and codes are licensed under MIT.
The datasets are used under fair use and derivative of the original sources.
[1]: https://cwiki.apache.org/confluence/display/solr/Filter+Descriptions#FilterDescriptions-SynonymFilter
[2]: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-tokenfilter.html#analysis-synonym-tokenfilter
[travis-img-url]: https://travis-ci.org/prashnts/elasticsearch-synonyms.svg?branch=master
[travis-href]: https://travis-ci.org/prashnts/elasticsearch-synonyms
[![Build Status][travis-img-url]][travis-href]
This repository contains a curated dataset of synonyms in [Solr Format][1]. These
synonyms can be used for [Elasticsearch Synonym Token Filter][2] configuration.
Additional helper tools in this repository:
- `synlint`: Commandline tool to lint and validate the synonym files.
- `synonyms.sublime-syntax`: Syntax highlighting file for Sublime Text 3.
## Datasets
Following datasets are currently available:
- `be-ae`: British English and American English Spellings. From [AVKO.org](https://to.noop.pw/2sNor7C).
## Usage
- The synonym files in `data/` can be used directly in configuration.
- To use the linter tool, install python dependencies from `requirements.txt` and use:
```shell
python -m synlint [file names]
```
- To run tests:
```shell
./panda test:all
```
## License
The tools and codes are licensed under MIT.
The datasets are used under fair use and derivative of the original sources.
[1]: https://cwiki.apache.org/confluence/display/solr/Filter+Descriptions#FilterDescriptions-SynonymFilter
[2]: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-tokenfilter.html#analysis-synonym-tokenfilter
[travis-img-url]: https://travis-ci.org/prashnts/elasticsearch-synonyms.svg?branch=master
[travis-href]: https://travis-ci.org/prashnts/elasticsearch-synonyms
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
Built Distribution
Close
Hashes for elasticsearch-synonym-toolkit-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46690b2029620ff6e5d5242a1a203ba4be4be31f7cf1d8974a845f00e155ebc7 |
|
MD5 | 9cf969ac4d4240996b0b38e6fb5397bc |
|
BLAKE2b-256 | 5ba6dfcbf02a798ec07ad0674aabf7eebdacc9554455025e128fcaba9914c63a |
Close
Hashes for elasticsearch_synonym_toolkit-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11bdc30979082526e8a676dd00375b4788981cb08db207097963157c573c3f27 |
|
MD5 | 6447110355a7c68318fbda5a93947420 |
|
BLAKE2b-256 | 849548482d63693e6e51c920e72ffee1e75db0423e6b9e5082cba5e3f2ca9ba7 |