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

Jonathan 83d61bdf7d Raise correct type of instance in case of error		2016-09-09 10:25:51 +02:00
cjellyfish@a319d6ae04	update cjellyfish	2016-06-21 18:55:28 -04:00
docs	0.5.6 release	2016-06-23 13:22:26 -04:00
jellyfish	Raise correct type of instance in case of error	2016-09-09 10:25:51 +02:00
testdata@6e545d1596	WH->W case for metaphone	2016-06-21 14:11:37 -04:00
.coveragerc	coveragerc	2014-08-11 15:02:13 -04:00
.gitignore	add new test for #52	2016-05-13 19:23:06 -04: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	Add docs/ and testdata/ to Manifest.in	2016-03-02 18:53:02 +01:00
README.rst	Unquote the bulleted lists	2016-08-15 20:36:06 -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	0.5.6 release	2016-06-23 13:22:26 -04: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/9xeyl1f5sd5pl40h?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(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'