Rooba
/
jellyfish
mirror of https://github.com/jamesturk/jellyfish.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
🎐 a python library for doing approximate and phonetic matching of strings.
415 Commits 9 Branches 51 Tags 5.1 MiB
Jupyter Notebook 86.1%
Rust 8.5%
Python 5.2%
Just 0.2%
Go to file
Dimitri Papadopoulos 71f885dab1
Shell script is executable but lacked a shebang 		2021-12-09 11:33:58 +01:00
.github test on 3.10 2021-10-05 12:30:48 -04:00
cjellyfish@8d3f440d90 update cjellyfish again 2021-11-14 17:25:38 -05:00
docs mkdocs changes 2021-11-10 14:56:41 -05:00
jellyfish Typo found by codespell 2021-11-15 12:39:49 +01:00
testdata@21eabbe8a7 testdata update for #155 2021-11-16 13:49:21 -05:00
.coveragerc coveragerc 2014-08-11 15:02:13 -04:00
.gitignore mkdocs changes 2021-11-10 14:56:41 -05:00
.gitmodules change submodule path 2015-04-22 01:50:10 -04:00
.pre-commit-config.yaml switch fully away from travis 2020-12-07 20:11:59 -05:00
LICENSE BSD-2 2015-06-16 17:02:11 -04:00
MANIFEST.in Add type annotations 2020-09-22 15:09:37 +03:00
README.md README markdown 2021-11-09 17:43:09 -05:00
build-wheels.sh add wheels 2020-05-21 15:41:40 -04:00
mkdocs.yml switch to functions.md 2021-11-10 14:54:19 -05:00
run-cov.sh Shell script is executable but lacked a shebang 2021-12-09 11:33:58 +01:00
setup.py Unnecessary `pass` statement 2021-11-15 15:08:35 +01:00
tox.ini update tox 2021-08-04 15:29:56 -04:00
upload-releases.sh Add aarch64 CI and wheel build support 2021-03-16 05:34:48 +00:00

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

PyPI badge Test badge Coveralls

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(u'jellyfish', u'smellyfish')
2
>>> jellyfish.jaro_distance(u'jellyfish', u'smellyfish')
0.89629629629629637
>>> jellyfish.damerau_levenshtein_distance(u'jellyfish', u'jellyfihs')
1

>>> jellyfish.metaphone(u'Jellyfish')
'JLFX'
>>> jellyfish.soundex(u'Jellyfish')
'J412'
>>> jellyfish.nysiis(u'Jellyfish')
'JALYF'
>>> jellyfish.match_rating_codex(u'Jellyfish')
'JLLFSH'