Algolia Search API Client for Python.
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.4to3.11 - Contains blazing-fast asynchronous methods built on top of the Asyncio
💡 Getting Started
First, install Algolia Python API Client via the pip package manager:
pip install --upgrade 'algoliasearch>=3.0,<4.0'
Then, create objects on your index:
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:
objects = index.search('Fo')
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-3.0.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e150a577435f5256a52e5f50c865138df2e434db640b9e71556e84c169a1da52 |
|
| MD5 | dfc8d855e6b8c969b9a0d77ef6d58bb0 |
|
| BLAKE2b-256 | ceca7c96366ec182272091b422b91042ead48a2fd921808825406f45a2667e9a |
