# QLev
<p>
<a href="https://pypi.org/project/QLev/">
<img src="https://img.shields.io/pypi/v/QLev"
alt="PyPI package version">
</a>
<a href="https://www.python.org">
<img src="https://img.shields.io/pypi/pyversions/QLev"
alt="Python versions">
</a>
<a href="https://pypi.org/project/QLev/">
<img src="https://img.shields.io/pypi/dm/QLev.svg?label=PyPI%20downloads"
alt="PyPI Downloads">
</a>
</p>
## Introduction
The QLev package is mainly used for:
* Levenshtein distance
* levenshtein distance normalized
* levenshtein distance considering the keyboard keys range
## Requirements
* Python 3 or later
## Installation
```bash
pip install QLev
```
## Guide
To use simple the levenshtein distance you can:
```python
from QLev import levenshteinDistance
diff = levenshteinDistance('Guacamole','Guecamole')
print(diff)
```
If you want to use the normalized metric, you can:
```python
from QLev import levN
diff = levN('Guacamole','Guecamole')
print(diff)
```
If you want to know the euclidian distance between two chars, you can:
```python
from QLev import qwertyDistance
diff = qwertyDistance('g','a')
print(diff)
```
To have a metric that uses levenshtein distance and the qwerty matrix, you can:
```python
from QLev import QLev
diff = QLev('Guacamole','Guecamole')
print(diff)
```
## License
MIT License
Copyright (c) 2022 Alysson Amaral
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": "https://github.com/alyssonamaral/QLev",
"name": "QLev",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,levenshtein,qwerty",
"author": "Alysson Amaral",
"author_email": "alysson.amaral@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/19/74/1505a9dba25e52de513a59d35c6567cbfd8179736735493d05a66369a3f9/QLev-0.0.95.tar.gz",
"platform": null,
"description": "# QLev\r\n\r\n<p>\r\n\r\n <a href=\"https://pypi.org/project/QLev/\">\r\n <img src=\"https://img.shields.io/pypi/v/QLev\"\r\n alt=\"PyPI package version\">\r\n </a>\r\n <a href=\"https://www.python.org\">\r\n <img src=\"https://img.shields.io/pypi/pyversions/QLev\"\r\n alt=\"Python versions\">\r\n </a>\r\n <a href=\"https://pypi.org/project/QLev/\">\r\n <img src=\"https://img.shields.io/pypi/dm/QLev.svg?label=PyPI%20downloads\"\r\n alt=\"PyPI Downloads\">\r\n </a>\r\n</p>\r\n\r\n## Introduction\r\nThe QLev package is mainly used for:\r\n\r\n* Levenshtein distance\r\n* levenshtein distance normalized\r\n* levenshtein distance considering the keyboard keys range \r\n\r\n## Requirements\r\n* Python 3 or later\r\n\r\n## Installation\r\n```bash\r\npip install QLev\r\n```\r\n\r\n## Guide\r\n\r\nTo use simple the levenshtein distance you can:\r\n\r\n```python\r\nfrom QLev import levenshteinDistance\r\n\r\ndiff = levenshteinDistance('Guacamole','Guecamole')\r\n\r\nprint(diff)\r\n```\r\nIf you want to use the normalized metric, you can:\r\n\r\n```python\r\nfrom QLev import levN\r\n\r\ndiff = levN('Guacamole','Guecamole')\r\n\r\nprint(diff)\r\n```\r\nIf you want to know the euclidian distance between two chars, you can:\r\n\r\n```python\r\nfrom QLev import qwertyDistance\r\n\r\ndiff = qwertyDistance('g','a')\r\n\r\nprint(diff)\r\n```\r\n\r\nTo have a metric that uses levenshtein distance and the qwerty matrix, you can:\r\n\r\n```python\r\nfrom QLev import QLev\r\n\r\ndiff = QLev('Guacamole','Guecamole')\r\n\r\nprint(diff)\r\n```\r\n\r\n\r\n## License\r\n\r\nMIT License\r\n\r\nCopyright (c) 2022 Alysson Amaral\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy\r\nof this software and associated documentation files (the \"Software\"), to deal\r\nin the Software without restriction, including without limitation the rights\r\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\ncopies of the Software, and to permit persons to whom the Software is\r\nfurnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all\r\ncopies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\nSOFTWARE.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "String distance metrics based on Levenshtein and Qwerty Matrix Distance",
"version": "0.0.95",
"split_keywords": [
"python",
"levenshtein",
"qwerty"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0de0de1520d8e0b15ffce066e99d3dc5",
"sha256": "4a038691108ea21d5eeee1d8c6d38fb24addc0787cc4bb215d78b39058e4c1bf"
},
"downloads": -1,
"filename": "QLev-0.0.95-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0de0de1520d8e0b15ffce066e99d3dc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4466,
"upload_time": "2022-12-06T18:29:34",
"upload_time_iso_8601": "2022-12-06T18:29:34.680405Z",
"url": "https://files.pythonhosted.org/packages/f9/5f/736007a9a2c6970e01bbd9f405c1db670d6ec38a644472cf272bb2d2110f/QLev-0.0.95-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "b36975b458b94f8ae8ec071d9a3b90b1",
"sha256": "b7bacb9e15ee4486491dff07a5c92019399b353bcfa58ad3c00f2216e25b6eb2"
},
"downloads": -1,
"filename": "QLev-0.0.95.tar.gz",
"has_sig": false,
"md5_digest": "b36975b458b94f8ae8ec071d9a3b90b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3729,
"upload_time": "2022-12-06T18:29:36",
"upload_time_iso_8601": "2022-12-06T18:29:36.653507Z",
"url": "https://files.pythonhosted.org/packages/19/74/1505a9dba25e52de513a59d35c6567cbfd8179736735493d05a66369a3f9/QLev-0.0.95.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-06 18:29:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "alyssonamaral",
"github_project": "QLev",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "qlev"
}
JSON
