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.
485 Commits 9 Branches 51 Tags 5.1 MiB
Jupyter Notebook 86.1%
Rust 8.5%
Python 5.2%
Just 0.2%
Go to file
James Turk 45c35b83f2 clippy fixes 2023-03-26 00:19:11 -05:00
.github expand matrix 2023-03-25 03:00:19 -05:00
benchmarks fix timedruns for new layout 2023-03-26 00:10:00 -05:00
docs switch out C refs for Rust 2023-03-25 02:38:34 -05:00
python/jellyfish bring together config & move to _rustyfish 2023-03-25 21:28:47 -05:00
src clippy fixes 2023-03-26 00:19:11 -05:00
testdata@8883ad26c9 update testdata with test for #90 2022-11-06 23:19:29 -06:00
tests bring together config & move to _rustyfish 2023-03-25 21:28:47 -05:00
.coveragerc coveragerc 2014-08-11 15:02:13 -04:00
.gitignore add rustyfish module 2023-03-25 01:42:01 -05:00
.gitmodules remove cjellyfish 2023-03-25 01:23:08 -05:00
.pre-commit-config.yaml switch fully away from travis 2020-12-07 20:11:59 -05:00
Cargo.toml fix timedruns for new layout 2023-03-26 00:10:00 -05:00
Justfile fix timedruns for new layout 2023-03-26 00:10:00 -05:00
LICENSE BSD-2 2015-06-16 17:02:11 -04:00
README.md bring together config & move to _rustyfish 2023-03-25 21:28:47 -05:00
mkdocs.yml switch to functions.md 2021-11-10 14:54:19 -05:00
pyproject.toml add rustyfish module 2023-03-25 01:42:01 -05:00
run-cov.sh Shell script is executable but lacked a shebang 2021-12-09 11:33:58 +01: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 Test Rust

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'