54 lines
1.6 KiB
Markdown
54 lines
1.6 KiB
Markdown
# Overview
|
|
|
|
**jellyfish** is a library for approximate & phonetic matching of strings.
|
|
|
|
Source: [https://github.com/jamesturk/jellyfish](https://github.com/jamesturk/jellyfish)
|
|
|
|
Documentation: [https://jamesturk.github.io/jellyfish/](https://jamesturk.github.io/jellyfish/)
|
|
|
|
Issues: [https://github.com/jamesturk/jellyfish/issues](https://github.com/jamesturk/jellyfish/issues)
|
|
|
|
[](https://badge.fury.io/py/jellyfish)
|
|
[](https://github.com/jamesturk/jellyfish/actions?query=workflow%3A%22Python+package)
|
|
[](https://coveralls.io/r/jamesturk/jellyfish)
|
|
|
|
|
|
## Included Algorithms
|
|
|
|
String comparison:
|
|
|
|
* Levenshtein Distance
|
|
* Damerau-Levenshtein Distance
|
|
* Jaro Distance
|
|
* Jaro-Winkler Distance
|
|
* Match Rating Approach Comparison
|
|
* Hamming Distance
|
|
|
|
Phonetic encoding:
|
|
|
|
* American Soundex
|
|
* Metaphone
|
|
* NYSIIS (New York State Identification and Intelligence System)
|
|
* Match Rating Codex
|
|
|
|
## Example Usage
|
|
|
|
``` python
|
|
>>> import jellyfish
|
|
>>> jellyfish.levenshtein_distance('jellyfish', 'smellyfish')
|
|
2
|
|
>>> jellyfish.jaro_distance('jellyfish', 'smellyfish')
|
|
0.89629629629629637
|
|
>>> jellyfish.damerau_levenshtein_distance('jellyfish', 'jellyfihs')
|
|
1
|
|
|
|
>>> jellyfish.metaphone('Jellyfish')
|
|
'JLFX'
|
|
>>> jellyfish.soundex('Jellyfish')
|
|
'J412'
|
|
>>> jellyfish.nysiis('Jellyfish')
|
|
'JALYF'
|
|
>>> jellyfish.match_rating_codex('Jellyfish')
|
|
'JLLFSH'
|
|
```
|