LibIndic Soundex

.. image:: https://img.shields.io/pypi/v/libindic-soundex.svg :target: https://pypi.python.org/pypi/libindic-soundex :alt: PyPI Version

Soundex is phonetic algorithm for indexing names by sound as pronounced in English. LibIndic_'s soundex module implements Soundex algorithm for Engish as well as a modified version of soundex algorithm for Indian languages.

Details on how Soundex is implemented can be found at Santhosh's blog

Installation

Python 3 is required. Using with venv_ is recommended

.. code-block:: console

$ pip install libindic-soundex

Usage

.. code-block:: Python

from libindic.soundex import Soundex
instance = Soundex()
instance.soundex(u"കൃത്രിമം")
u'\u0d15PKPBN00'
instance.compare(u"വിദ്യാർഥി", u"വിദ്യാർദി")
1
instance.compare(u"മോര്", u"മുതിര")
-1
instance.compare(u'ಬೆಂಗಳೂರು', u'बॆंगळूरु')
2

.. _LibIndic: https://libindic.org .. _venv: https://docs.python.org/3/library/venv.html