# Elyzer
See step-by-step how Elasticsearch custom analyzers decompose your text into tokens.
My therapist said this would be a good idea…
<pre> Doug: hi Eliza: How are you today.. What would you like to discuss? Doug: well I can’t really see how my Elasticsearch analyzers work, on the inside Eliza: How do you know you can’t really see how your Elasticsearch analyzers work, on the inside? Doug: cause I call _analyze, and it does the whole analyzer or just one step Eliza What other reasons might there be? Doug: I guess nobody’s gotten around to making a good debugger Eliza I’m not sure I understand you fully. Doug well just keep reading this README then… Eliza Come, come, elucidate your thoughts. </pre>
# Installation
Install through pip3
(ES 2.x & 5.x)
pip3 install elyzer
# Usage
Give Elyzer some text and have its analyzed. See the process broken down step-by-step on the command line.
Assuming I’d created an english_bigrams custom analyzer for the index tmdb, I would run the analyzer like so
` $ elyzer --es "http://localhost:9200" --index tmdb --analyzer english_bigrams "Mary had a little lamb" TOKENIZER: standard {1:Mary} {2:had} {3:a} {4:little} {5:lamb} TOKEN_FILTER: standard {1:Mary} {2:had} {3:a} {4:little} {5:lamb} TOKEN_FILTER: lowercase {1:mary} {2:had} {3:a} {4:little} {5:lamb} TOKEN_FILTER: porter_stem {1:mari} {2:had} {3:a} {4:littl} {5:lamb} TOKEN_FILTER: bigram_filter {1:mari had} {2:had a} {3:a littl} {4:littl lamb} `
Output is each token, prefixed by the numerical position attribute in the token stream at each step.
## Args
There are four required command line args:
es: the elasticsearch host (ie http://localhost:9200)
index: name of the index where your custom analyzer can be found
analyzer: name of your custom analyzer
text: the text to analyze
# Shortcomings
aka “Areas for Improvement” - Only works for custom analyzers right now (as it accesses the settings for your index) - Attributes besides the token text and position would be handy
## Who?
Created by [OpenSource Connections](http://opensourceconnections.com)
## License
Released under [Apache 2](LICENSE.txt)
Metadata
Release files for elyzer 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| elyzer-1.2.2.tar.gz | 4.5 kB | Without provenance | Details for elyzer-1.2.2.tar.gz |
Release files / elyzer-1.2.2.tar.gz
| Download URL | elyzer-1.2.2.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
05409b8167ac3b54efe7b19536b72c5eee785005a44e5cf2f23ba6cf9e4f4a12
|
|
BLAKE2b-256 checksum How to use checksums |
9265d0235397337c179b85a18d0b23e58fec5b0bc96c0005d8fd92ac4c6068a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for elyzer 1.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.