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.
207 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 0eac14610c Revert "try building on OSX, why not" 
This reverts commit 6e4fb1355a.
 		2015-05-08 14:08:40 -04:00
cjellyfish@22cbc7705b update cjellyfish w/ fix for nysiis 2015-05-01 14:52:24 -04:00
docs bump to 0.5.1 2015-05-01 17:45:41 -04:00
jellyfish update tests and add a couple nysiis fixes 2015-05-01 14:43:24 -04:00
testdata@c5aa82da97 update tests and add a couple nysiis fixes 2015-05-01 14:43:24 -04: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 Revert "try building on OSX, why not" 2015-05-08 14:08:40 -04:00
LICENSE bump year 2015-03-27 14:38:55 -04:00
MANIFEST.in install right .h files 2014-07-16 08:23:11 -04:00
README.rst appveyor badge 2015-04-22 19:55:12 -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 bump to 0.5.1 2015-05-01 17:45:41 -04:00
tox.ini remove pytest benchmark, way too slow for normal use 2015-04-22 01:14:48 -04:00

README.rst 

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

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

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

.. image:: https://pypip.in/version/jellyfish/badge.svg
    :target: https://pypi.python.org/pypi/jellyfish

.. image:: https://pypip.in/format/jellyfish/badge.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/github/sunlightlabs/jellyfish?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.

jellyfish is a project of Sunlight Labs (c) 2014.
All code is released under a BSD-style license, see LICENSE for details.

Written by James Turk <jturk@sunlightfoundation.com> and Michael Stephens.

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

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