jellyfish

🎐 a python library for doing approximate and phonetic matching of strings.

fuzzy-search hacktoberfest hamming jaro-winkler levenshtein metaphone python soundex starred-jamesturk-repo starred-repo

Go to file

Diego Moreda 703b3962a1 Remove unused imports for flake8 compliance Remove unused imports from `docs/conf.py` and `setup.py`.		2016-03-02 16:20:48 +01:00
cjellyfish@a3b62e7149	update cjellyfish to pass test	2015-07-12 20:10:09 -04:00
docs	Remove unused imports for flake8 compliance	2016-03-02 16:20:48 +01:00
jellyfish	Manual fixes for further PEP8 warnings	2016-03-02 16:05:22 +01:00
testdata@d8a328f87b	update testdata to includ Utah for metaphone	2016-02-03 08:45:15 -05:00
.coveragerc	coveragerc	2014-08-11 15:02:13 -04:00
.gitignore	initial pass at algorithms docs	2015-02-24 18:15:51 -05:00
.gitmodules	change submodule path	2015-04-22 01:50:10 -04:00
.run_with_env.cmd	appveyor	2015-04-22 19:12:55 -04:00
.travis.yml	3.5 tox env may work	2015-10-08 20:36:35 -04:00
LICENSE	BSD-2	2015-06-16 17:02:11 -04:00
MANIFEST.in	install right .h files	2014-07-16 08:23:11 -04:00
README.rst	merge readme	2015-06-15 15:03:57 -04:00
appveyor.yml	add wheel dep to appveyor	2015-04-23 01:17:20 -04:00
run-cov.sh	quite a few tests for NYSIIS, fixing some issues in the C implementation	2015-02-19 17:34:45 -05:00
setup.py	Remove unused imports for flake8 compliance	2016-03-02 16:20:48 +01:00
tox.ini	unicodecsv is available on py3	2015-10-08 20:22:59 -04:00

README.rst

=========
jellyfish
=========

.. image:: https://travis-ci.org/jamesturk/jellyfish.svg?branch=master
    :target: https://travis-ci.org/jamesturk/jellyfish

.. image:: https://coveralls.io/repos/jamesturk/jellyfish/badge.png?branch=master
    :target: https://coveralls.io/r/jamesturk/jellyfish

.. image:: https://img.shields.io/pypi/v/jellyfish.svg
    :target: https://pypi.python.org/pypi/jellyfish

.. image:: https://readthedocs.org/projects/jellyfish/badge/?version=latest
    :target: https://readthedocs.org/projects/jellyfish/?badge=latest
    :alt: Documentation Status

.. image:: https://ci.appveyor.com/api/projects/status/t5o03rqcusxhhe41/branch/master?svg=true
    :target: https://ci.appveyor.com/project/jamesturk/jellyfish/

Jellyfish is a python library for doing approximate and phonetic matching of strings.

Written by James Turk <james.p.turk@gmail.com> and Michael Stephens.

See https://github.com/jamesturk/jellyfish/graphs/contributors for contributors.

Source is available at http://github.com/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
=============

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