# django-find-similar
find-similar integration for django
You can find **Full Project Documentation** [here][documentation_path]
<hr>
#### Workflows
[](https://github.com/findsimilar/django-find-similar/actions/workflows/run-tests.yml)
[](https://github.com/findsimilar/django-find-similar/actions/workflows/lint.yml)
#### Package
[](https://pypi.python.org/pypi/django-find-similar/)
[](https://pypi.python.org/pypi/django-find-similar)
[](https://pypi.python.org/pypi/django-find-similar/)
[](https://github.com/findsimilar/django-find-similarblob/main/LICENSE)
[](https://pypi.python.org/pypi/django-find-similar/)
#### Support
[][documentation_path]
[](https://github.com/findsimilar/django-find-similar/discussions/)
[](https://github.com/findsimilar/django-find-similar/issues/)
#### Downloads
[](https://pepy.tech/project/django-find-similar)
[](https://pepy.tech/project/django-find-similar)
[](https://pepy.tech/project/django-find-similar)
[](https://pepy.tech/project/django-find-similar)
#### Languages
[](https://github.com/findsimilar/django-find-similar)
[](https://github.com/findsimilar/django-find-similar)
#### Development
- [](https://github.com/findsimilar/django-find-similar/releases)
[](https://github.com/findsimilar/django-find-similar)
- [](https://github.com/findsimilar/django-find-similar/issues/)
[](https://github.com/findsimilar/django-find-similar/issues/)
- [](https://github.com/findsimilar/django-find-similar/pulls)
[](https://github.com/findsimilar/django-find-similar/pulls)
- [](https://github.com/findsimilar/django-find-similar/discussions/)
[//]: # (#### Repository Stats)
[//]: # ([
[//]: # ()](https://github.com/findsimilar/django-find-similar))
[//]: # ([
[//]: # ()](https://github.com/findsimilar/django-find-similargraphs/contributors))
[//]: # ([
[//]: # ()](https://github.com/findsimilar/django-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
To provide find-similar integration with django projects
## Open Source Project
This is the open source project with [MIT license](LICENSE).
Be free to use, fork, clone and contribute.
## Features
- Django models
- Django forms
## Requirements
- django, find-similar
- See more in [Full Documentation](https://dfs.craftsman.lol/about.html#requirements)
## Development Status
- Package already available on [PyPi](https://pypi.org/project/django-find-similar/)
- See more in [Full Documentation](https://dfs.craftsman.lol/about.html#development-status)
## Install
### with pip
```commandline
pip install django-find-similar
```
See more in [Full Documentation](https://dfs.craftsman.lol/install.html)
## Quickstart
```python
from django_find_similar.models import FindSimilarInput, Text
input_data = {
'text': Text.objects.create(text='one two'),
# 'texts': [Text.objects.create(text='one'), Text.objects.create(text='two')],
'language': "english",
'count': 5,
# 'dictionary': None,
'remove_stopwords': True,
# 'keywords': None,
}
find_similar_input = FindSimilarInput.objects.create(
**input_data
)
texts = [Text.objects.create(text='one'), Text.objects.create(text='two')]
for text in texts:
find_similar_input.texts.add(text)
find_similar_input.save()
```
### 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://dfs.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://dfs.craftsman.lol
Raw data
{
"_id": null,
"home_page": "https://github.com/findsimilar/django-find-similar",
"name": "django-find-similar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "python, django, find-similar, integration",
"author": "quillcraftsman",
"author_email": "quill@craftsman.lol",
"download_url": "https://files.pythonhosted.org/packages/cb/5a/60ed22026f578b4add1b333130c2ad56cc2f69f854bec97b8f1c20b3711d/django_find_similar-1.4.0.tar.gz",
"platform": null,
"description": "# django-find-similar\n\nfind-similar integration for django\n\nYou can find **Full Project Documentation** [here][documentation_path]\n\n<hr>\n\n#### Workflows\n[](https://github.com/findsimilar/django-find-similar/actions/workflows/run-tests.yml)\n[](https://github.com/findsimilar/django-find-similar/actions/workflows/lint.yml)\n\n#### Package\n[](https://pypi.python.org/pypi/django-find-similar/)\n[](https://pypi.python.org/pypi/django-find-similar)\n[](https://pypi.python.org/pypi/django-find-similar/)\n[](https://github.com/findsimilar/django-find-similarblob/main/LICENSE)\n[](https://pypi.python.org/pypi/django-find-similar/)\n\n#### Support\n[][documentation_path]\n[](https://github.com/findsimilar/django-find-similar/discussions/)\n[](https://github.com/findsimilar/django-find-similar/issues/)\n\n#### Downloads\n[](https://pepy.tech/project/django-find-similar)\n[](https://pepy.tech/project/django-find-similar)\n[](https://pepy.tech/project/django-find-similar)\n[](https://pepy.tech/project/django-find-similar)\n\n#### Languages\n[](https://github.com/findsimilar/django-find-similar)\n[](https://github.com/findsimilar/django-find-similar)\n\n#### Development\n- [](https://github.com/findsimilar/django-find-similar/releases)\n[](https://github.com/findsimilar/django-find-similar)\n- [](https://github.com/findsimilar/django-find-similar/issues/)\n[](https://github.com/findsimilar/django-find-similar/issues/)\n- [](https://github.com/findsimilar/django-find-similar/pulls)\n[](https://github.com/findsimilar/django-find-similar/pulls)\n- [](https://github.com/findsimilar/django-find-similar/discussions/)\n\n[//]: # (#### Repository Stats)\n\n[//]: # ([\n\n[//]: # ()](https://github.com/findsimilar/django-find-similar))\n\n[//]: # ([\n\n[//]: # ()](https://github.com/findsimilar/django-find-similargraphs/contributors))\n\n[//]: # ([\n\n[//]: # ()](https://github.com/findsimilar/django-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\nTo provide find-similar integration with django projects\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\n- Django models\n- Django forms\n\n## Requirements\n\n- django, find-similar\n- See more in [Full Documentation](https://dfs.craftsman.lol/about.html#requirements)\n\n## Development Status\n\n- Package already available on [PyPi](https://pypi.org/project/django-find-similar/)\n- See more in [Full Documentation](https://dfs.craftsman.lol/about.html#development-status)\n\n## Install\n\n### with pip\n\n```commandline\npip install django-find-similar\n```\n\nSee more in [Full Documentation](https://dfs.craftsman.lol/install.html)\n\n## Quickstart\n\n```python\nfrom django_find_similar.models import FindSimilarInput, Text\n\ninput_data = {\n 'text': Text.objects.create(text='one two'),\n # 'texts': [Text.objects.create(text='one'), Text.objects.create(text='two')],\n 'language': \"english\",\n 'count': 5,\n # 'dictionary': None,\n 'remove_stopwords': True,\n # 'keywords': None,\n}\n\nfind_similar_input = FindSimilarInput.objects.create(\n **input_data\n)\n\ntexts = [Text.objects.create(text='one'), Text.objects.create(text='two')]\n\nfor text in texts:\n find_similar_input.texts.add(text)\nfind_similar_input.save()\n```\n\n### 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://dfs.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://dfs.craftsman.lol\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "find-similar integration for django",
"version": "1.4.0",
"project_urls": {
"Changelog": "https://github.com/findsimilar/django-find-similar/releases",
"Documentation": "https://dfs.craftsman.lol",
"Download": "https://pypi.org/project/django-find-similar/",
"Homepage": "https://github.com/findsimilar/django-find-similar",
"Release notes": "https://github.com/findsimilar/django-find-similar/releases",
"Source": "https://github.com/findsimilar/django-find-similar",
"Tracker": "https://github.com/findsimilar/django-find-similar/issues"
},
"split_keywords": [
"python",
" django",
" find-similar",
" integration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c956c9fc530e53ccae7ee324b9472fdf79a0b177b266203f4a797565e2126f55",
"md5": "28287a9e55ecf25ad091dce2a3cee39a",
"sha256": "960437d20ff02f9ec26e35a6e54024761126153a958749dab5f71a684b908ec6"
},
"downloads": -1,
"filename": "django_find_similar-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28287a9e55ecf25ad091dce2a3cee39a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 10810,
"upload_time": "2024-04-16T14:52:24",
"upload_time_iso_8601": "2024-04-16T14:52:24.219170Z",
"url": "https://files.pythonhosted.org/packages/c9/56/c9fc530e53ccae7ee324b9472fdf79a0b177b266203f4a797565e2126f55/django_find_similar-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb5a60ed22026f578b4add1b333130c2ad56cc2f69f854bec97b8f1c20b3711d",
"md5": "5a4acda26571425b4cfa641d5d4be255",
"sha256": "5b2e9404a356c0fe379f278a3c15b1f0d7597338c36cb794d6e6d746eb325b96"
},
"downloads": -1,
"filename": "django_find_similar-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "5a4acda26571425b4cfa641d5d4be255",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 9681,
"upload_time": "2024-04-16T14:52:25",
"upload_time_iso_8601": "2024-04-16T14:52:25.772270Z",
"url": "https://files.pythonhosted.org/packages/cb/5a/60ed22026f578b4add1b333130c2ad56cc2f69f854bec97b8f1c20b3711d/django_find_similar-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 14:52:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "findsimilar",
"github_project": "django-find-similar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "django-find-similar"
}
JSON
