Skip to main content

Algolia Search API Client for Python.

Project description

Algolia for Python

The perfect starting point to integrate Algolia within your Python project

PyPI Python versions License

DocumentationDjangoCommunity ForumStack OverflowReport a bugFAQSupport

✨ Features

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

❓ 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.

📄 License

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

Project details


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

algoliasearch-2.5.0.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

algoliasearch-2.5.0-py2.py3-none-any.whl (32.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file algoliasearch-2.5.0.tar.gz.

File metadata

  • Download URL: algoliasearch-2.5.0.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.7.0 requests/2.25.1 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.2

File hashes

Hashes for algoliasearch-2.5.0.tar.gz
Algorithm Hash digest
SHA256 55f30029d8be666c00cfb57ce2d14f0cde438ab720278aa25012fad61e4dc89d
MD5 fc20e3c0d8098f6b80417c06804fc2b9
BLAKE2b-256 567cf389078bea4938ac2aeccc495b678f4ba5e3d9d5f90b99439af4a04483ee

See more details on using hashes here.

File details

Details for the file algoliasearch-2.5.0-py2.py3-none-any.whl.

File metadata

  • Download URL: algoliasearch-2.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 32.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.7.0 requests/2.25.1 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.2

File hashes

Hashes for algoliasearch-2.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 789b0dbce108e8494803835036d9c54cd212f53bfd01fc253d2882bc8ff2d668
MD5 97e6051a1391b9a3119c43295af93d3b
BLAKE2b-256 ed0cc5f3f3f81b07871dde5b6a7c5c5dc2d21a0d2f269e3607bbcf2b98cb6b9b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page