# fuzstr
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n fuzstr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install fuzstr
```
### nbdev
``` sh
# activate conda environment
$ conda activate fuzstr
# make sure the fuzstr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the fuzstr package
$ nbdev_prepare
```
### Publishing
``` sh
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'
```
# Usage
## Installation
Install latest from the GitHub
[repository](https://github.com/dsm-72/fuzstr):
``` sh
$ pip install git+https://github.com/dsm-72/fuzstr.git
```
or from [conda](https://anaconda.org/dsm-72/fuzstr)
``` sh
$ conda install -c dsm-72 fuzstr
```
or from [pypi](https://pypi.org/project/fuzstr/)
``` sh
$ pip install fuzstr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/fuzstr)
[pages](https://dsm-72.github.io/fuzstr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/fuzstr) and
[pypi](https://pypi.org/project/fuzstr/) respectively.
### [`fuzstr`](https://dsm-72.github.io/fuzstr/core.html#fuzstr)
``` python
apple = fuzstr('Apple', icase=False, ispace=False, iunder=False, cutoff=1)
grape = fuzstr('Grape', icase=True, ispace=True, iunder=True, cutoff=1)
mango = fuzstr('Mango')
for fruit in (apple, grape, mango):
rstr = fruit.raw.lower()
print(
f'{fruit}:',
fruit == fuzstr(rstr), fruit == fruit.makesame(rstr),
fruit == fruit.makesame(rstr), fruit == fuzstr(rstr),
)
```
Apple: False False False False
Grape: True True True True
Mango: True True True True
``` python
apple.prep(apple), apple.prep(mango), mango.prep(apple), mango.prep(mango), issubclass(type(mango), fuzstr)
```
('Apple', 'Mango', 'apple', 'mango', True)
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/fuzstr",
"name": "fuzstr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python fuzstr fuzzy strings str fuzz fuzzywuzzy",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/74/70/9bf477ba76ea316ce5783c2b6317c9cedbb6c518e47806f34686c4883327/fuzstr-0.0.7.tar.gz",
"platform": null,
"description": "# fuzstr\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\n### Setup\n\n``` sh\n# create conda environment\n$ mamba env create -f env.yml\n\n# update conda environment\n$ mamba env update -n fuzstr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install fuzstr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate fuzstr\n\n# make sure the fuzstr package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to the fuzstr package\n$ nbdev_prepare\n```\n\n### Publishing\n\n``` sh\n# publish to pypi\n$ nbdev_pypi\n\n# publish to conda\n$ nbdev_conda --build_args '-c conda-forge'\n$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/fuzstr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/fuzstr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/fuzstr)\n\n``` sh\n$ conda install -c dsm-72 fuzstr\n```\n\nor from [pypi](https://pypi.org/project/fuzstr/)\n\n``` sh\n$ pip install fuzstr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/fuzstr)\n[pages](https://dsm-72.github.io/fuzstr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/fuzstr) and\n[pypi](https://pypi.org/project/fuzstr/) respectively.\n\n### [`fuzstr`](https://dsm-72.github.io/fuzstr/core.html#fuzstr)\n\n``` python\napple = fuzstr('Apple', icase=False, ispace=False, iunder=False, cutoff=1)\ngrape = fuzstr('Grape', icase=True, ispace=True, iunder=True, cutoff=1)\nmango = fuzstr('Mango')\n\nfor fruit in (apple, grape, mango):\n rstr = fruit.raw.lower()\n print(\n f'{fruit}:', \n fruit == fuzstr(rstr), fruit == fruit.makesame(rstr), \n fruit == fruit.makesame(rstr), fruit == fuzstr(rstr),\n )\n```\n\n Apple: False False False False\n Grape: True True True True\n Mango: True True True True\n\n``` python\napple.prep(apple), apple.prep(mango), mango.prep(apple), mango.prep(mango), issubclass(type(mango), fuzstr)\n```\n\n ('Apple', 'Mango', 'apple', 'mango', True)\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "fuzzy string matching",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/dsm-72/fuzstr"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"fuzstr",
"fuzzy",
"strings",
"str",
"fuzz",
"fuzzywuzzy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e81ddf3302efd1cc50633bfe111babeee6830d10f8d823b3603ed934fb9bea01",
"md5": "c21e5112bf4b4eb86632ba82d12b349e",
"sha256": "7eba9d8256601a42059a34e4595a4c08828a5e35f4c17f5f76912c705ec2b394"
},
"downloads": -1,
"filename": "fuzstr-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c21e5112bf4b4eb86632ba82d12b349e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9653,
"upload_time": "2023-09-10T15:54:56",
"upload_time_iso_8601": "2023-09-10T15:54:56.682728Z",
"url": "https://files.pythonhosted.org/packages/e8/1d/df3302efd1cc50633bfe111babeee6830d10f8d823b3603ed934fb9bea01/fuzstr-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74709bf477ba76ea316ce5783c2b6317c9cedbb6c518e47806f34686c4883327",
"md5": "4be2838c5b23b76b7c5d66535bf9afaf",
"sha256": "0f557a11c64041a3bf72722ee818288338070541bad22ca4a95e95072dade8b7"
},
"downloads": -1,
"filename": "fuzstr-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "4be2838c5b23b76b7c5d66535bf9afaf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10215,
"upload_time": "2023-09-10T15:54:58",
"upload_time_iso_8601": "2023-09-10T15:54:58.507190Z",
"url": "https://files.pythonhosted.org/packages/74/70/9bf477ba76ea316ce5783c2b6317c9cedbb6c518e47806f34686c4883327/fuzstr-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-10 15:54:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "fuzstr",
"github_not_found": true,
"lcname": "fuzstr"
}
JSON
