<p align="center">
<a href="https://www.algolia.com">
<img alt="Algolia for Python" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/python.png" >
</a>
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Python project</h4>
<p align="center">
<a href="https://pypi.org/project/algoliasearch"><img src="https://img.shields.io/pypi/v/algoliasearch.svg" alt="PyPI"></img></a>
<a href="https://pypi.org/project/algoliasearch"><img src="https://img.shields.io/pypi/pyversions/ansicolortags.svg" alt="Python versions"></img></a>
<a href="https://pypi.org/project/algoliasearch"><img src="https://img.shields.io/pypi/l/ansicolortags.svg" alt="License"></a>
</p>
</p>
<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/python/" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/algoliasearch-django" target="_blank">Django</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-python/issues" target="_blank">Report a bug</a> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/python/" target="_blank">FAQ</a> •
<a href="https://www.algolia.com/support" target="_blank">Support</a>
</p>
## ✨ Features
- Thin & minimal low-level HTTP client to interact with Algolia's API
- Supports Python from `3.4` to `3.11`
- Contains blazing-fast asynchronous methods built on top of the [Asyncio](https://docs.python.org/3/library/asyncio.html)
## 💡 Getting Started
First, install Algolia Python API Client via the [pip](https://pip.pypa.io/en/stable/installing) package manager:
```bash
pip install --upgrade 'algoliasearch>=3.0,<4.0'
```
Then, create objects on your index:
```py
from algoliasearch.search_client import SearchClient
client = SearchClient.create('YourApplicationID', 'YourAPIKey')
index = client.init_index('your_index_name')
index.save_objects([{'objectID': 1, 'name': 'Foo'}])
```
Finally, you may begin searching a object using the `search` method:
```py
objects = index.search('Fo')
```
For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/api-client/getting-started/install/python/)**.
## ❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/python/) where you will find answers for the most common issues and gotchas with the client.
## Use the Dockerfile
If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.MD) to learn more.
## 📄 License
Algolia Python API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/algolia/algoliasearch-client-python",
"name": "algoliasearch",
"maintainer": "Algolia Team",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "support@algolia.com",
"keywords": "algolia,py,search,backend,hosted,cloud,full-text search,faceted search",
"author": "Algolia Team",
"author_email": "support@algolia.com",
"download_url": "https://files.pythonhosted.org/packages/c3/3a/68b9136bab8d04f837c5b1893be1de2d6403f9cb5f18961194a168e90917/algoliasearch-3.0.0.tar.gz",
"platform": "any",
"description": "<p align=\"center\">\n <a href=\"https://www.algolia.com\">\n <img alt=\"Algolia for Python\" src=\"https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/python.png\" >\n </a>\n\n <h4 align=\"center\">The perfect starting point to integrate <a href=\"https://algolia.com\" target=\"_blank\">Algolia</a> within your Python project</h4>\n\n <p align=\"center\">\n <a href=\"https://pypi.org/project/algoliasearch\"><img src=\"https://img.shields.io/pypi/v/algoliasearch.svg\" alt=\"PyPI\"></img></a>\n <a href=\"https://pypi.org/project/algoliasearch\"><img src=\"https://img.shields.io/pypi/pyversions/ansicolortags.svg\" alt=\"Python versions\"></img></a>\n <a href=\"https://pypi.org/project/algoliasearch\"><img src=\"https://img.shields.io/pypi/l/ansicolortags.svg\" alt=\"License\"></a>\n </p>\n</p>\n\n<p align=\"center\">\n <a href=\"https://www.algolia.com/doc/api-client/getting-started/install/python/\" target=\"_blank\">Documentation</a> \u2022\n <a href=\"https://github.com/algolia/algoliasearch-django\" target=\"_blank\">Django</a> \u2022\n <a href=\"https://discourse.algolia.com\" target=\"_blank\">Community Forum</a> \u2022\n <a href=\"http://stackoverflow.com/questions/tagged/algolia\" target=\"_blank\">Stack Overflow</a> \u2022\n <a href=\"https://github.com/algolia/algoliasearch-client-python/issues\" target=\"_blank\">Report a bug</a> \u2022\n <a href=\"https://www.algolia.com/doc/api-client/troubleshooting/faq/python/\" target=\"_blank\">FAQ</a> \u2022\n <a href=\"https://www.algolia.com/support\" target=\"_blank\">Support</a>\n</p>\n\n## \u2728 Features\n\n- Thin & minimal low-level HTTP client to interact with Algolia's API\n- Supports Python from `3.4` to `3.11`\n- Contains blazing-fast asynchronous methods built on top of the [Asyncio](https://docs.python.org/3/library/asyncio.html)\n\n## \ud83d\udca1 Getting Started\n\nFirst, install Algolia Python API Client via the [pip](https://pip.pypa.io/en/stable/installing) package manager:\n\n```bash\npip install --upgrade 'algoliasearch>=3.0,<4.0'\n```\n\nThen, create objects on your index:\n\n```py\nfrom algoliasearch.search_client import SearchClient\n\nclient = SearchClient.create('YourApplicationID', 'YourAPIKey')\nindex = client.init_index('your_index_name')\n\nindex.save_objects([{'objectID': 1, 'name': 'Foo'}])\n```\n\nFinally, you may begin searching a object using the `search` method:\n\n```py\nobjects = index.search('Fo')\n```\n\nFor full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/api-client/getting-started/install/python/)**.\n\n## \u2753 Troubleshooting\n\nEncountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/python/) where you will find answers for the most common issues and gotchas with the client.\n\n## Use the Dockerfile\n\nIf you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.MD) to learn more.\n\n## \ud83d\udcc4 License\n\nAlgolia Python API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Algolia Search API Client for Python.",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/algolia/algoliasearch-client-python"
},
"split_keywords": [
"algolia",
"py",
"search",
"backend",
"hosted",
"cloud",
"full-text search",
"faceted search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ceca7c96366ec182272091b422b91042ead48a2fd921808825406f45a2667e9a",
"md5": "dfc8d855e6b8c969b9a0d77ef6d58bb0",
"sha256": "e150a577435f5256a52e5f50c865138df2e434db640b9e71556e84c169a1da52"
},
"downloads": -1,
"filename": "algoliasearch-3.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfc8d855e6b8c969b9a0d77ef6d58bb0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.4",
"size": 33390,
"upload_time": "2023-02-27T08:58:28",
"upload_time_iso_8601": "2023-02-27T08:58:28.003649Z",
"url": "https://files.pythonhosted.org/packages/ce/ca/7c96366ec182272091b422b91042ead48a2fd921808825406f45a2667e9a/algoliasearch-3.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c33a68b9136bab8d04f837c5b1893be1de2d6403f9cb5f18961194a168e90917",
"md5": "eaf7dc662a69abeebe4b8ee3cf7fb4b4",
"sha256": "abd9316f81fec1e322db4faf183081383b334188ac8184baab36405533038cdd"
},
"downloads": -1,
"filename": "algoliasearch-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "eaf7dc662a69abeebe4b8ee3cf7fb4b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 21671,
"upload_time": "2023-02-27T08:58:30",
"upload_time_iso_8601": "2023-02-27T08:58:30.075668Z",
"url": "https://files.pythonhosted.org/packages/c3/3a/68b9136bab8d04f837c5b1893be1de2d6403f9cb5f18961194a168e90917/algoliasearch-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-27 08:58:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "algolia",
"github_project": "algoliasearch-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [
{
"name": "setuptools",
"specs": []
},
{
"name": "tox",
"specs": []
},
{
"name": "mypy",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "types-requests",
"specs": []
}
],
"tox": true,
"lcname": "algoliasearch"
}
JSON
