A fully-featured and blazing-fast Python API client to interact with Algolia.
Project description
The perfect starting point to integrate Algolia within your Python project
Documentation • Django • Community Forum • Stack Overflow • Report a bug • FAQ • Support
✨ Features
- Thin & minimal low-level HTTP client to interact with Algolia's API
- Supports Python from
3.8to3.12
💡 Getting Started
First, install Algolia Python API Client via the pip package manager:
pip install --upgrade 'algoliasearch>=4.0,<5.0'
Now you can initialize any client with your Algolia credentials, for example the SearchClient:
from algoliasearch.search.client import SearchClient
client = SearchClient.create("YOUR_APP_ID", "YOUR_API_KEY")
Add new object to your index:
save_resp = await client.save_object(index_name="nvim", body={"description": "blazing fast"})
Wait for the task to be processed on the Algolia side
await client.wait_for_task(index_name="nvim", task_id=save_resp.task_id)
Finally, you may begin searching a object using the search method:
# using a raw dict
search_resp = await client.search(search_method_params={"requests": [{"indexName": "nvim"}]})
# using the given models
from algoliasearch.search.models.search_method_params import SearchMethodParams
from algoliasearch.search.models.search_for_hits import SearchForHits
from algoliasearch.search.models.search_query import SearchQuery
search_resp = await client.search(
search_method_params=SearchMethodParams(
requests=[
SearchQuery(SearchForHits(index_name="nvim")),
],
),
)
print(search_resp.to_json())
For full documentation, visit the Algolia Python API Client.
❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ 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 to learn more.
📄 License
Algolia Python API Client is an open-sourced software licensed under the MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for algoliasearch-4.0.0a6-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ac227f031e5627877b5c9fbf8cc6c57cf7a80464ecf24fe7fbf96b477cfdbbb5 |
|
| MD5 | bd78bbfcb8495b1fb21b1477dd786c46 |
|
| BLAKE2b-256 | e85b0026198e5a6260368245025f182f31cf0ecf0a3e935d77361db169a83dee |
