Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/algoliasearch-client-python
⚡️ A fully-featured and blazing-fast Python API client to interact with Algolia.
https://github.com/algolia/algoliasearch-client-python
algolia python search
Last synced: about 2 months ago
JSON representation
⚡️ A fully-featured and blazing-fast Python API client to interact with Algolia.
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-client-python
- Owner: algolia
- License: mit
- Created: 2013-05-22T13:57:40.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T12:12:39.000Z (5 months ago)
- Last Synced: 2024-04-11T05:18:23.075Z (5 months ago)
- Topics: algolia, python, search
- Language: Python
- Homepage: https://www.algolia.com/doc/api-client/getting-started/install/python/?language=python
- Size: 66 MB
- Stars: 193
- Watchers: 82
- Forks: 76
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-blazingly-fast - algoliasearch-client-python - ⚡️ A fully-featured and blazing-fast Python API client to interact with Algolia. (Python)
README
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](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).