commit	baa16fda91d4943a4e0f93a3b802d61fd24dc9ca	[log] [tgz]
author	James Turk <dev@jamesturk.net>	Sat Mar 25 02:40:19 2023 -0500
committer	James Turk <dev@jamesturk.net>	Sat Mar 25 02:40:19 2023 -0500
tree	b6fd99cc638220e181aa073f6752f2e30f02e6b3
parent	7b65689a50bda2e23493f7701950f00647eb0e42 [diff]

tree: b6fd99cc638220e181aa073f6752f2e30f02e6b3

README.md

Overview

jellyfish is a library for approximate & phonetic matching of strings.

Source: https://github.com/jamesturk/jellyfish

Documentation: https://jamesturk.github.io/jellyfish/

Issues: https://github.com/jamesturk/jellyfish/issues

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

>>> 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'