Project: algoliasearch

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.4 to 3.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.