<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/libraries/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://alg.li/support" target="_blank">Support</a>
</p>
## ✨ Features
- Thin & minimal low-level HTTP client to interact with Algolia's API
- Supports Python from `3.8`
## 💡 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>=4.0,<5.0'
```
You can now import the Algolia API client in your project and play with it.
```py
from algoliasearch.search.client import SearchClient
_client = SearchClient("YOUR_APP_ID", "YOUR_API_KEY")
# Add a new record to your Algolia index
response = await _client.save_object(
index_name="<YOUR_INDEX_NAME>",
body={
"objectID": "id",
"test": "val",
},
)
# use the class directly
print(response)
# print the JSON response
print(response.to_json())
# Poll the task status to know when it has been indexed
await client.wait_for_task(index_name="<YOUR_INDEX_NAME>", task_id=response.task_id)
# Fetch search results, with typo tolerance
response = await _client.search(
search_method_params={
"requests": [
{
"indexName": "<YOUR_INDEX_NAME>",
"query": "<YOUR_QUERY>",
"hitsPerPage": 50,
},
],
},
)
# use the class directly
print(response)
# print the JSON response
print(response.to_json())
```
For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/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. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
## Contributing
This repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
## 📄 License
The Algolia Python API Client is an open-sourced software licensed under the [MIT license](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://www.algolia.com",
"name": "algoliasearch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.1",
"maintainer_email": null,
"keywords": "algolia, search, full-text-search, neural-search",
"author": "Algolia Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0f/b2/ba0674e22a353fbe53d7d486d9b20809880675c3d4c733ac4ddf7f214a03/algoliasearch-4.11.2.tar.gz",
"platform": null,
"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/libraries/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://alg.li/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.8`\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>=4.0,<5.0'\n```\n\nYou can now import the Algolia API client in your project and play with it.\n\n```py\nfrom algoliasearch.search.client import SearchClient\n\n_client = SearchClient(\"YOUR_APP_ID\", \"YOUR_API_KEY\")\n\n# Add a new record to your Algolia index\nresponse = await _client.save_object(\n index_name=\"<YOUR_INDEX_NAME>\",\n body={\n \"objectID\": \"id\",\n \"test\": \"val\",\n },\n)\n\n# use the class directly\nprint(response)\n\n# print the JSON response\nprint(response.to_json())\n\n# Poll the task status to know when it has been indexed\nawait client.wait_for_task(index_name=\"<YOUR_INDEX_NAME>\", task_id=response.task_id)\n\n# Fetch search results, with typo tolerance\nresponse = await _client.search(\n search_method_params={\n \"requests\": [\n {\n \"indexName\": \"<YOUR_INDEX_NAME>\",\n \"query\": \"<YOUR_QUERY>\",\n \"hitsPerPage\": 50,\n },\n ],\n },\n)\n\n# use the class directly\nprint(response)\n\n# print the JSON response\nprint(response.to_json())\n```\n\nFor full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/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. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)\n\n## Contributing\n\nThis repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).\n\n## \ud83d\udcc4 License\n\nThe Algolia Python API Client is an open-sourced software licensed under the [MIT license](LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A fully-featured and blazing-fast Python API client to interact with Algolia.",
"version": "4.11.2",
"project_urls": {
"Homepage": "https://www.algolia.com",
"Repository": "https://github.com/algolia/algoliasearch-client-python"
},
"split_keywords": [
"algolia",
" search",
" full-text-search",
" neural-search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8cb621c7e2e9383d057e180b4c2af352b7996a1a194fa0fcf35223d0f7dac7ed",
"md5": "e69dcf2d11dc61afdb11baa030f79216",
"sha256": "d7638a4f3e6f3df02be3c4a46f739c28e756eda019933bcc9145f42c94119a71"
},
"downloads": -1,
"filename": "algoliasearch-4.11.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e69dcf2d11dc61afdb11baa030f79216",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1",
"size": 827486,
"upload_time": "2024-12-18T11:29:18",
"upload_time_iso_8601": "2024-12-18T11:29:18.517016Z",
"url": "https://files.pythonhosted.org/packages/8c/b6/21c7e2e9383d057e180b4c2af352b7996a1a194fa0fcf35223d0f7dac7ed/algoliasearch-4.11.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fb2ba0674e22a353fbe53d7d486d9b20809880675c3d4c733ac4ddf7f214a03",
"md5": "c45262ad87e42759eed00e40ee440a7b",
"sha256": "51400d4bd041147515d96149a4198881ad70066bcfccf6f468d8d3b2e5de649d"
},
"downloads": -1,
"filename": "algoliasearch-4.11.2.tar.gz",
"has_sig": false,
"md5_digest": "c45262ad87e42759eed00e40ee440a7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1",
"size": 330904,
"upload_time": "2024-12-18T11:29:21",
"upload_time_iso_8601": "2024-12-18T11:29:21.690533Z",
"url": "https://files.pythonhosted.org/packages/0f/b2/ba0674e22a353fbe53d7d486d9b20809880675c3d4c733ac4ddf7f214a03/algoliasearch-4.11.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 11:29:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "algolia",
"github_project": "algoliasearch-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "algoliasearch"
}
JSON
