pyphonetics


Namepyphonetics JSON
Version 0.5.3 PyPI version JSON
download
home_pagehttps://github.com/Lilykos/pyphonetics
SummaryA Python 3 phonetics library.
upload_time2020-02-25 12:08:31
maintainer
docs_urlNone
authorLilykos
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===========
Pyphonetics
===========

Pyphonetics is a Python 3 library for phonetic algorithms. Right now, the following algorithms are implemented and supported:

 * Soundex
 * Metaphone
 * Refined Soundex
 * Fuzzy Soundex
 * Lein
 * Matching Rating Approach

More will be added in the future.

Instalation
***********

The module is available in PyPI, just use `pip install pyphonetics`.


Usage
*****

    >>> from pyphonetics import Soundex
    >>> soundex = Soundex()
    >>> soundex.phonetics('Rupert')
    'R163'
    >>> soundex.phonetics('Robert')
    'R163'
    >>> soundex.sounds_like('Robert', 'Rupert')
    True


The same API applies to every algorithm, e.g:

    >>> from pyphonetics import Metaphone
    >>> metaphone = Metaphone()
    >>> metaphone.phonetics('discrimination')
    'TSKRMNXN'

You can also use the `distance(word1, word2, metric='levenshtein')` method to find the distance between 2 phonetic representations.

    >>> from pyphonetics import RefinedSoundex
    >>> rs = RefinedSoundex()
    >>> rs.distance('Rupert', 'Robert')
    0
    >>> rs.distance('assign', 'assist', metric='hamming')
    2

Credits
=======

The module was largely based on the implementation of phonetic algorithms found in the Talisman.js (https://github.com/Yomguithereal/talisman) Node NLP library.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Lilykos/pyphonetics",
    "name": "pyphonetics",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Lilykos",
    "author_email": "ilias.koutsakis@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d6/7c/7c45a9e9bf6ddb57b67e66cf4e8076a7baf3a790a3411daac1a7a2df0c5b/pyphonetics-0.5.3.tar.gz",
    "platform": "",
    "description": "===========\nPyphonetics\n===========\n\nPyphonetics is a Python 3 library for phonetic algorithms. Right now, the following algorithms are implemented and supported:\n\n * Soundex\n * Metaphone\n * Refined Soundex\n * Fuzzy Soundex\n * Lein\n * Matching Rating Approach\n\nMore will be added in the future.\n\nInstalation\n***********\n\nThe module is available in PyPI, just use `pip install pyphonetics`.\n\n\nUsage\n*****\n\n    >>> from pyphonetics import Soundex\n    >>> soundex = Soundex()\n    >>> soundex.phonetics('Rupert')\n    'R163'\n    >>> soundex.phonetics('Robert')\n    'R163'\n    >>> soundex.sounds_like('Robert', 'Rupert')\n    True\n\n\nThe same API applies to every algorithm, e.g:\n\n    >>> from pyphonetics import Metaphone\n    >>> metaphone = Metaphone()\n    >>> metaphone.phonetics('discrimination')\n    'TSKRMNXN'\n\nYou can also use the `distance(word1, word2, metric='levenshtein')` method to find the distance between 2 phonetic representations.\n\n    >>> from pyphonetics import RefinedSoundex\n    >>> rs = RefinedSoundex()\n    >>> rs.distance('Rupert', 'Robert')\n    0\n    >>> rs.distance('assign', 'assist', metric='hamming')\n    2\n\nCredits\n=======\n\nThe module was largely based on the implementation of phonetic algorithms found in the Talisman.js (https://github.com/Yomguithereal/talisman) Node NLP library.",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Python 3 phonetics library.",
    "version": "0.5.3",
    "project_urls": {
        "Homepage": "https://github.com/Lilykos/pyphonetics"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bddda7d0a860efd3d4335d538b4361b8e9af8311f2aba2e8c7e4c7a47d623b6e",
                "md5": "79f177174b13c77eb737d041f374b3df",
                "sha256": "e6b29671d0d624dda1cac59c0c5a8a7216d8db504bae4941bfc482e04a0621d1"
            },
            "downloads": -1,
            "filename": "pyphonetics-0.5.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "79f177174b13c77eb737d041f374b3df",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 10729,
            "upload_time": "2020-02-25T12:08:25",
            "upload_time_iso_8601": "2020-02-25T12:08:25.368066Z",
            "url": "https://files.pythonhosted.org/packages/bd/dd/a7d0a860efd3d4335d538b4361b8e9af8311f2aba2e8c7e4c7a47d623b6e/pyphonetics-0.5.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d67c7c45a9e9bf6ddb57b67e66cf4e8076a7baf3a790a3411daac1a7a2df0c5b",
                "md5": "550d46d06d2f8c07831fca6041d7e6fe",
                "sha256": "2d3c2e359fde91a3c57914f0b5468bba7a5daf38e7927fd999992ea68990fbe4"
            },
            "downloads": -1,
            "filename": "pyphonetics-0.5.3.tar.gz",
            "has_sig": false,
            "md5_digest": "550d46d06d2f8c07831fca6041d7e6fe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10314,
            "upload_time": "2020-02-25T12:08:31",
            "upload_time_iso_8601": "2020-02-25T12:08:31.049117Z",
            "url": "https://files.pythonhosted.org/packages/d6/7c/7c45a9e9bf6ddb57b67e66cf4e8076a7baf3a790a3411daac1a7a2df0c5b/pyphonetics-0.5.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-02-25 12:08:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Lilykos",
    "github_project": "pyphonetics",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pyphonetics"
}
        
Elapsed time: 0.10986s