Metadata-Version: 2.0
Name: phonetics
Version: 1.0.1
Summary: UNKNOWN
Home-page: https://github.com/Zack--/phonetics
Author: Zack Dibe
Author-email: contact@zackdibe.com
License: MIT
Keywords: phonetics metaphone soundex indexing search fuzzy
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Topic :: Text Processing :: General
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5

=========
Phonetics
=========

The phonetics module computes the phonetic key of a string using different algorithms.

 * Soundex
 * NYSISS
 * Metaphone
 * Double Metaphone

The phonetics module defines the following function:

phonetics.soundex(source[, size=4])
  Use the soundex algorithm to create the phonetic key of the *source string.

phonetics.nysiis(source)
  Use the New York State Identification and Intelligence System to create the phonetic key of the *source string.

phonetics.metaphone(source)
  Use the metaphone algorithm to create the phonetic key of the *source string.

phonetics.dmetaphone(source)
  Use the double methaphone algorithm to create the phonetic key of the *source string.


Based on `Lawrence Philips' Metaphone Algorithm <http://aspell.net/metaphone/>`_

Installation
************

.. code-block:: shell

  $ pip install phonetics


Usage
*****

.. code-block:: python

  >>> import phonetics
  >>> phonetics.dmetaphone('Danger')
  ('TNJR', 'TNKR')


Tests
*****

By `Duncan McGreggor <https://github.com/oubiwann>`_

.. code-block:: shell

  $ python -m unittest discover phonetics/tests/ -v




