===========
Phonetics
===========
|PyPI-Status| |PyPI-Versions|
|LICENCE|
The phonetics module computes the phonetic key of a string using different algorithms.
* Soundex
* NYSISS
* Metaphone
* Double Metaphone
------------------------------------------
.. contents:: Table of contents
:backlinks: top
:local:
Installation
============
Latest PyPI stable release
--------------------------
|PyPI-Status|
.. code:: sh
pip install phonetics
Latest development release on github
------------------------------------
|GitHub-Status| |GitHub-Stars| |GitHub-Forks|
Pull and install in the current directory:
.. code:: sh
pip install -e git+https://github.com/Zack--/phonetics.git@master#egg=phonetics
Running tests
-------------
By `Duncan McGreggor <https://github.com/oubiwann>`_
.. code-block:: shell
$ python -m unittest discover phonetics/tests/ -v
Or
.. code:: sh
nosetests --with-coverage --cover-package=phonetics
Usage
=====
.. code-block:: python
>>> import phonetics
>>> phonetics.dmetaphone('Danger')
('TNJR', 'TNKR')
Module Contents
===============
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.
| Based on `Lawrence Philips' Metaphone Algorithm <http://aspell.net/metaphone/>`__.
``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/>`__.
Contributions
=============
All source code is hosted on `GitHub <https://github.com/ToasterCo/apiaiassistant>`__.
Contributions are welcome.
See the
`CONTRIBUTING <https://raw.githubusercontent.com/Zack--/apiaiassistant/master/CONTRIBUTING.md>`__
file for more information.
LICENCE
=======
Open Source : |LICENCE|
Authors
=======
Ranked by contributions.
- Zack Dibe (Zack--) *
`*` Original author
.. |PyPI-Status| image:: https://img.shields.io/pypi/v/phonetics.svg
:target: https://pypi.python.org/pypi/phonetics
.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/phonetics.svg
:target: https://pypi.python.org/pypi/phonetics
.. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/phonetics.svg
:target: https://pypi.python.org/pypi/phonetics
.. |LICENCE| image:: https://img.shields.io/pypi/l/phonetics.svg
:target: https://raw.githubusercontent.com/Zack--/phonetics/master/LICENCE
.. |GitHub-Status| image:: https://img.shields.io/github/tag/Zack--/phonetics.svg?maxAge=2592000
:target: https://github.com/Zack--/phonetics/releases
.. |GitHub-Forks| image:: https://img.shields.io/github/forks/Zack--/phonetics.svg
:target: https://github.com/Zack--/phonetics/network
.. |GitHub-Stars| image:: https://img.shields.io/github/stars/Zack--/phonetics.svg
:target: https://github.com/Zack--/phonetics/stargazers
Raw data
{
"_id": null,
"home_page": "https://github.com/smirnoffs/phonetics-py",
"name": "phonetics-py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "phonetics metaphone soundex indexing search fuzzy",
"author": "Zack Dibe",
"author_email": "contact@zackdibe.com",
"download_url": "https://files.pythonhosted.org/packages/f7/f7/49457b866597d6f4d81c928ea908a9fc70482db8271e796ff85e648c7be5/phonetics-py-1.0.5.tar.gz",
"platform": null,
"description": "===========\n Phonetics\n===========\n\n|PyPI-Status| |PyPI-Versions|\n\n|LICENCE|\n\nThe phonetics module computes the phonetic key of a string using different algorithms.\n\n * Soundex\n * NYSISS\n * Metaphone\n * Double Metaphone\n\n------------------------------------------\n\n.. contents:: Table of contents\n :backlinks: top\n :local:\n\n\nInstallation\n============\n\nLatest PyPI stable release\n--------------------------\n\n|PyPI-Status|\n\n.. code:: sh\n\n pip install phonetics\n\nLatest development release on github\n------------------------------------\n\n|GitHub-Status| |GitHub-Stars| |GitHub-Forks|\n\nPull and install in the current directory:\n\n.. code:: sh\n\n pip install -e git+https://github.com/Zack--/phonetics.git@master#egg=phonetics\n\nRunning tests\n-------------\n\nBy `Duncan McGreggor <https://github.com/oubiwann>`_\n\n.. code-block:: shell\n\n $ python -m unittest discover phonetics/tests/ -v\n\nOr\n\n.. code:: sh\n\n nosetests --with-coverage --cover-package=phonetics\n\nUsage\n=====\n\n.. code-block:: python\n\n >>> import phonetics\n >>> phonetics.dmetaphone('Danger')\n ('TNJR', 'TNKR')\n\n\nModule Contents\n===============\n\nThe ``phonetics`` module defines the following function:\n\n``phonetics``. **soundex**\\(*source* [, *size=4*])\n Use the soundex algorithm to create the phonetic key of the **source** string.\n\n``phonetics``. **nysiis**\\(*source*)\n Use the New York State Identification and Intelligence System to create the phonetic key of the **source** string.\n\n``phonetics``. **metaphone**\\(*source*)\n | Use the metaphone algorithm to create the phonetic key of the **source** string.\n | Based on `Lawrence Philips' Metaphone Algorithm <http://aspell.net/metaphone/>`__.\n\n``phonetics``. **dmetaphone**\\(*source*)\n | Use the double methaphone algorithm to create the phonetic key of the **source** string.\n | Based on `Lawrence Philips' Metaphone Algorithm <http://aspell.net/metaphone/>`__.\n\nContributions\n=============\n\nAll source code is hosted on `GitHub <https://github.com/ToasterCo/apiaiassistant>`__.\nContributions are welcome.\n\nSee the\n`CONTRIBUTING <https://raw.githubusercontent.com/Zack--/apiaiassistant/master/CONTRIBUTING.md>`__\nfile for more information.\n\n\nLICENCE\n=======\n\nOpen Source : |LICENCE|\n\nAuthors\n=======\n\nRanked by contributions.\n\n- Zack Dibe (Zack--) *\n\n`*` Original author\n\n.. |PyPI-Status| image:: https://img.shields.io/pypi/v/phonetics.svg\n :target: https://pypi.python.org/pypi/phonetics\n\n.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/phonetics.svg\n :target: https://pypi.python.org/pypi/phonetics\n\n.. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/phonetics.svg\n :target: https://pypi.python.org/pypi/phonetics\n\n.. |LICENCE| image:: https://img.shields.io/pypi/l/phonetics.svg\n :target: https://raw.githubusercontent.com/Zack--/phonetics/master/LICENCE\n\n.. |GitHub-Status| image:: https://img.shields.io/github/tag/Zack--/phonetics.svg?maxAge=2592000\n :target: https://github.com/Zack--/phonetics/releases\n\n.. |GitHub-Forks| image:: https://img.shields.io/github/forks/Zack--/phonetics.svg\n :target: https://github.com/Zack--/phonetics/network\n\n.. |GitHub-Stars| image:: https://img.shields.io/github/stars/Zack--/phonetics.svg\n :target: https://github.com/Zack--/phonetics/stargazers\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Compute phonetic key of strings for indexing or fuzzy matching",
"version": "1.0.5",
"split_keywords": [
"phonetics",
"metaphone",
"soundex",
"indexing",
"search",
"fuzzy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e2344a1a794bd119981a27acf307a2fc02df07b372873aa54c92a234959b77b",
"md5": "1896ecbfd9baa6539b5b0ce6b762e76a",
"sha256": "07ce0c1a06f3cadb064781a02b2222b663f38f820d3aeec7601a87bba17c6dff"
},
"downloads": -1,
"filename": "phonetics_py-1.0.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1896ecbfd9baa6539b5b0ce6b762e76a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 8737,
"upload_time": "2023-01-03T14:08:46",
"upload_time_iso_8601": "2023-01-03T14:08:46.890370Z",
"url": "https://files.pythonhosted.org/packages/2e/23/44a1a794bd119981a27acf307a2fc02df07b372873aa54c92a234959b77b/phonetics_py-1.0.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f7f749457b866597d6f4d81c928ea908a9fc70482db8271e796ff85e648c7be5",
"md5": "cddb454469a286d4a38b3278080b2ef9",
"sha256": "670c0551792bbcca23933fffb61d84367f60e6e32964196f9c72b3b1eb6ed1e9"
},
"downloads": -1,
"filename": "phonetics-py-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "cddb454469a286d4a38b3278080b2ef9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9334,
"upload_time": "2023-01-03T14:08:48",
"upload_time_iso_8601": "2023-01-03T14:08:48.662657Z",
"url": "https://files.pythonhosted.org/packages/f7/f7/49457b866597d6f4d81c928ea908a9fc70482db8271e796ff85e648c7be5/phonetics-py-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-03 14:08:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "smirnoffs",
"github_project": "phonetics-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "phonetics-py"
}
JSON
