🎐 a python library for doing approximate and phonetic matching of strings.
Go to file
James Turk eeb8a826cd switch back to v3 for now 2024-05-28 12:58:15 -05:00
.github switch back to v3 for now 2024-05-28 12:58:15 -05:00
benchmarks Apply pyupgrade suggestions (#193) 2023-08-13 20:32:34 -05:00
docs update changelog 2023-11-17 14:35:16 -06:00
python/jellyfish fix mrc (#203) 2023-11-17 12:56:02 -06:00
src add new tests and fix for #210 2024-05-28 12:53:56 -05:00
testdata@9eaccb5222 add new tests and fix for #210 2024-05-28 12:53:56 -05:00
tests fix mrc (#203) 2023-11-17 12:56:02 -06: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
CITATION.cff move to top level 2023-08-16 00:19:43 -05:00
Cargo.toml Bumped version of pyo3 dependency (#202) 2023-11-17 12:56:19 -06:00
Justfile Update Justfile 2023-10-14 01:45:10 -05:00
LICENSE 0.11.0 2023-03-26 22:09:38 -05:00
README.md remove outdated references to jaro_distance, closes #198 2023-11-13 16:44:04 -06:00
mkdocs.yml bump version 2023-06-21 11:51:52 -05:00
pyproject.toml Allow maturin 1.x (#191) 2023-06-27 17:37:24 -04: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_similarity('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'