Skip to content

phound-inc/algoliasearch-client-python

 
 

Repository files navigation

Algolia for Python

The perfect starting point to integrate Algolia within your Python project

Build Status PyPI Python versions License

DocumentationDjangoCommunity ForumStack OverflowReport a bugSupport

✨ Features

  • Thin & minimal low-level HTTP client to interact with Algolia's API
  • Supports Python: 2.7, 3.4, 3.5, 3.6, and 3.7
  • 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>=2.0,<3.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.

📄 License

Algolia Python API Client is an open-sourced software licensed under the MIT license.

About

Algolia Search API Client for Python

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.7%
  • Shell 0.3%