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
The synonym files in `data/` can be used directly in elasticsearch configuration.
Following datasets are currently available:
- `be-ae`: British English and American English Spellings. From [AVKO.org](https://to.noop.pw/2sNor7C).
## Installation
If you want to use the `synlint` tool, install the package from PIP using:
```shell
pip install elasticsearch-synonym-toolkit
```
This will install a linter tool, `es-synlint`. Use it with:
```shell
es-synlint [synonymfile]
```
## Development
- Clone this repository.
- Install package dependencies via `pip` with: `pip install -r requirements.txt`.
- To run tests:
```shell
./panda test:all
```
## License
The tools and codes are licensed under MIT.
The datasets are used under fair use and are 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
The synonym files in `data/` can be used directly in elasticsearch configuration.
Following datasets are currently available:
- `be-ae`: British English and American English Spellings. From [AVKO.org](https://to.noop.pw/2sNor7C).
## Installation
If you want to use the `synlint` tool, install the package from PIP using:
```shell
pip install elasticsearch-synonym-toolkit
```
This will install a linter tool, `es-synlint`. Use it with:
```shell
es-synlint [synonymfile]
```
## Development
- Clone this repository.
- Install package dependencies via `pip` with: `pip install -r requirements.txt`.
- To run tests:
```shell
./panda test:all
```
## License
The tools and codes are licensed under MIT.
The datasets are used under fair use and are 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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0165ddd163802ce2019f6906605b0f6a68afc0ff3c87e107eff27beb3d80f434 |
|
MD5 | ec66e28b05774f35e1b32d450591523e |
|
BLAKE2b-256 | 541aeff7b6b85df6a4ff6cf702c895fcec9f3f4bbf511d4156638a98c29f5d4a |
Close
Hashes for elasticsearch_synonym_toolkit-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0925833070254dabadc8ba887ca8e68c24ea106eff2f87d8e8c824ecb21cad18 |
|
MD5 | a3d4b383f70e2a4c19479be828b2c09e |
|
BLAKE2b-256 | e0839b66f6f81a07ff60f726da24d21bbaa6922622b64c21521b4b8c6a3d83ac |