# FindSimilar
User-friendly library to find similar objects
You can find **Full Project Documentation** [here][documentation_path]
<hr>
#### Workflows
[](https://github.com/findsimilar/find-similar/actions/workflows/run-tests.yml)
[](https://github.com/findsimilar/find-similar/actions/workflows/lint.yml)
#### PyPi
[](https://pypi.python.org/pypi/find-similar/)
[](https://pypi.python.org/pypi/find-similar)
[](https://pypi.python.org/pypi/find-similar/)
[](https://pypi.python.org/pypi/find-similar/)
### Anaconda
[](https://anaconda.org/quillcraftsman/find-similar/)
[](https://anaconda.org/quillcraftsman/find-similar/)
[](https://anaconda.org/quillcraftsman/find-similar/)
### License
[](https://github.com/findsimilar/find-similar/blob/main/LICENSE)
#### Support
[][documentation_path]
[](https://github.com/findsimilar/find-similar/discussions/)
[](https://github.com/findsimilar/find-similar/issues/)
#### PyPi Downloads
[](https://pepy.tech/project/find-similar)
[](https://pepy.tech/project/find-similar)
[](https://pepy.tech/project/find-similar)
#### Anaconda Downloads
[](https://anaconda.org/quillcraftsman/find-similar/)
#### Languages
[](https://github.com/findsimilar/find-similar)
[](https://github.com/findsimilar/find-similar)
#### Development
- [](https://github.com/findsimilar/find-similar/releases)
[](https://github.com/findsimilar/find-similar)
- [](https://github.com/findsimilar/find-similar/issues/)
[](https://github.com/findsimilar/find-similar/issues/)
- [](https://github.com/findsimilar/find-similar/pulls)
[](https://github.com/findsimilar/find-similar/pulls)
- [](https://github.com/findsimilar/find-similar/discussions/)
#### Repository Stats
[](https://github.com/findsimilar/find-similar)
[](https://github.com/findsimilar/find-similargraphs/contributors)
[](https://github.com/findsimilar/find-similar)
<hr>
## Menu
- [Mission](#mission)
- [Open Source Project](#open-source-project)
- [Features](#features)
- [Requirements](#requirements)
- [Development Status](#development-status)
- [Install](#install)
- [Quickstart](#quickstart)
- [Contributing](#contributing)
## Mission
The mission of the **FindSimilar** project is to provide a powerful and versatile open source library that empowers
developers to efficiently find similar objects and perform comparisons across a variety of data types.
Whether dealing with texts, images, audio, or more,
our project aims to simplify the process of identifying similarities and enhancing decision-making.
## Open Source Project
This is the open source project with [MIT license](LICENSE).
Be free to use, fork, clone and contribute.
## Features
Find similar texts
- on different languages
- with or without stopwords
- using dictionary (or not)
- using keywords (or not)
## Requirements
- nltk, pymorphy3
- See more in [Full Documentation](https://findsimilar.craftsman.lol/about.html#requirements)
## Development Status
- Package already available on [PyPi](https://pypi.org/project/find-similar/)
- See more in [Full Documentation](https://findsimilar.craftsman.lol/about.html#development-status)
## Install
### with pip
```commandline
pip install find-similar
```
See more in [Full Documentation](https://findsimilar.craftsman.lol/install.html)
## Quickstart
```python
from find_similar import find_similar
texts = ['one two', 'two three', 'three four']
text_to_compare = 'one four'
find_similar(text_to_compare, texts, count=10)
```
```commandline
[TokenText(text="one two", len(tokens)=2, cos=0.5), TokenText(text="three four", len(tokens)=2, cos=0.5), TokenText(text="two three", len(tokens)=2, cos=0)]
```
- The result is the list of `TokenText` instances ordering by `cos`
- `cos` is the mark of texts similarity
### See more examples in [Full Documentation][documentation_path]
## Contributing
You are welcome! To easy start please check:
- [Full Documentation][documentation_path]
- [Contributing](CONTRIBUTING.md)
- [Developer Documentation](https://findsimilar.craftsman.lol/dev_documentation.html)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Security Policy](SECURITY.md)
- [Governance](GOVERNANCE.md)
- [Support](SUPPORT.md)
[documentation_path]: https://findsimilar.craftsman.lol
Raw data
{
"_id": null,
"home_page": "https://github.com/findsimilar/find-similar",
"name": "find-similar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "python, search, machine-learning, natural-language-processing, find, words, texts, similar",
"author": "findsimilar",
"author_email": "quill@craftsman.lol",
"download_url": "https://files.pythonhosted.org/packages/1f/3b/b34e9121f75a17404960a06b8c7f22f6066b09e056284a1d6be3c7b8dacf/find_similar-2.2.1.tar.gz",
"platform": null,
"description": "# FindSimilar\n\nUser-friendly library to find similar objects\n\nYou can find **Full Project Documentation** [here][documentation_path]\n\n<hr>\n\n#### Workflows\n[](https://github.com/findsimilar/find-similar/actions/workflows/run-tests.yml)\n[](https://github.com/findsimilar/find-similar/actions/workflows/lint.yml)\n\n#### PyPi\n[](https://pypi.python.org/pypi/find-similar/)\n[](https://pypi.python.org/pypi/find-similar)\n[](https://pypi.python.org/pypi/find-similar/)\n[](https://pypi.python.org/pypi/find-similar/)\n\n### Anaconda\n[](https://anaconda.org/quillcraftsman/find-similar/)\n[](https://anaconda.org/quillcraftsman/find-similar/)\n[](https://anaconda.org/quillcraftsman/find-similar/)\n\n### License\n[](https://github.com/findsimilar/find-similar/blob/main/LICENSE)\n\n#### Support\n[][documentation_path]\n[](https://github.com/findsimilar/find-similar/discussions/)\n[](https://github.com/findsimilar/find-similar/issues/)\n\n#### PyPi Downloads\n[](https://pepy.tech/project/find-similar)\n[](https://pepy.tech/project/find-similar)\n[](https://pepy.tech/project/find-similar)\n#### Anaconda Downloads\n[](https://anaconda.org/quillcraftsman/find-similar/)\n\n#### Languages\n[](https://github.com/findsimilar/find-similar)\n[](https://github.com/findsimilar/find-similar)\n\n#### Development\n- [](https://github.com/findsimilar/find-similar/releases)\n[](https://github.com/findsimilar/find-similar)\n- [](https://github.com/findsimilar/find-similar/issues/)\n[](https://github.com/findsimilar/find-similar/issues/)\n- [](https://github.com/findsimilar/find-similar/pulls)\n[](https://github.com/findsimilar/find-similar/pulls)\n- [](https://github.com/findsimilar/find-similar/discussions/)\n\n#### Repository Stats\n\n[](https://github.com/findsimilar/find-similar)\n[](https://github.com/findsimilar/find-similargraphs/contributors)\n[](https://github.com/findsimilar/find-similar)\n\n<hr>\n\n## Menu\n\n- [Mission](#mission)\n- [Open Source Project](#open-source-project)\n- [Features](#features)\n- [Requirements](#requirements)\n- [Development Status](#development-status)\n- [Install](#install)\n- [Quickstart](#quickstart)\n- [Contributing](#contributing)\n\n## Mission\n\nThe mission of the **FindSimilar** project is to provide a powerful and versatile open source library that empowers \ndevelopers to efficiently find similar objects and perform comparisons across a variety of data types.\nWhether dealing with texts, images, audio, or more, \nour project aims to simplify the process of identifying similarities and enhancing decision-making.\n\n## Open Source Project\n\nThis is the open source project with [MIT license](LICENSE). \nBe free to use, fork, clone and contribute.\n\n## Features\n\nFind similar texts\n- on different languages\n- with or without stopwords\n- using dictionary (or not)\n- using keywords (or not)\n\n## Requirements\n\n- nltk, pymorphy3\n- See more in [Full Documentation](https://findsimilar.craftsman.lol/about.html#requirements)\n\n## Development Status\n\n- Package already available on [PyPi](https://pypi.org/project/find-similar/)\n- See more in [Full Documentation](https://findsimilar.craftsman.lol/about.html#development-status)\n\n## Install\n\n### with pip\n\n```commandline\npip install find-similar\n```\n\nSee more in [Full Documentation](https://findsimilar.craftsman.lol/install.html)\n\n## Quickstart\n\n```python\nfrom find_similar import find_similar\n\ntexts = ['one two', 'two three', 'three four']\n\ntext_to_compare = 'one four'\nfind_similar(text_to_compare, texts, count=10)\n```\n\n```commandline\n[TokenText(text=\"one two\", len(tokens)=2, cos=0.5), TokenText(text=\"three four\", len(tokens)=2, cos=0.5), TokenText(text=\"two three\", len(tokens)=2, cos=0)]\n```\n\n- The result is the list of `TokenText` instances ordering by `cos`\n- `cos` is the mark of texts similarity\n\n### See more examples in [Full Documentation][documentation_path]\n\n## Contributing\n\nYou are welcome! To easy start please check:\n- [Full Documentation][documentation_path]\n- [Contributing](CONTRIBUTING.md)\n- [Developer Documentation](https://findsimilar.craftsman.lol/dev_documentation.html)\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Security Policy](SECURITY.md)\n- [Governance](GOVERNANCE.md)\n- [Support](SUPPORT.md)\n\n[documentation_path]: https://findsimilar.craftsman.lol\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "User-friendly library to find similar objects",
"version": "2.2.1",
"project_urls": {
"Changelog": "https://github.com/findsimilar/find-similar/releases",
"Documentation": "https://findsimilar.craftsman.lol",
"Download": "https://pypi.org/project/find-similar/",
"Homepage": "https://github.com/findsimilar/find-similar",
"Release notes": "https://github.com/findsimilar/find-similar/releases",
"Source": "https://github.com/findsimilar/find-similar",
"Tracker": "https://github.com/findsimilar/find-similar/issues"
},
"split_keywords": [
"python",
" search",
" machine-learning",
" natural-language-processing",
" find",
" words",
" texts",
" similar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e4b1cc9bd5e993fb81861e39808eb7546e4400e66f602c50eb59f6fbbca50d3",
"md5": "53e48de67794c4e4bc8364571a9ff808",
"sha256": "abbc99c2ada7bd14ab8d2baa6c92d45f9a53b15620817796f097f09b4c0ddbd5"
},
"downloads": -1,
"filename": "find_similar-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53e48de67794c4e4bc8364571a9ff808",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 16871,
"upload_time": "2024-04-16T14:35:44",
"upload_time_iso_8601": "2024-04-16T14:35:44.810005Z",
"url": "https://files.pythonhosted.org/packages/9e/4b/1cc9bd5e993fb81861e39808eb7546e4400e66f602c50eb59f6fbbca50d3/find_similar-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f3bb34e9121f75a17404960a06b8c7f22f6066b09e056284a1d6be3c7b8dacf",
"md5": "abae8be8844b2ed4ba25df78d1b52647",
"sha256": "0741407aa3a38a49f5ae3a783220afcc03addcf32e45887f6287d3667f97e4b5"
},
"downloads": -1,
"filename": "find_similar-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "abae8be8844b2ed4ba25df78d1b52647",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 16364,
"upload_time": "2024-04-16T14:35:46",
"upload_time_iso_8601": "2024-04-16T14:35:46.579182Z",
"url": "https://files.pythonhosted.org/packages/1f/3b/b34e9121f75a17404960a06b8c7f22f6066b09e056284a1d6be3c7b8dacf/find_similar-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 14:35:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "findsimilar",
"github_project": "find-similar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "find-similar"
}
JSON
