Algolia Search API Client for Python
Maintainers
Project description
Algolia Search API Client for Python
Algolia Search is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
The Algolia Search API Client for Python lets you easily use the Algolia Search REST API from your Python code.
Build Status PyPI version Coverage Status
We implemented an asynchronous version of the client that may suit your need if you are using a framework such as aiohttp in your backend. This version can be found here.
API Documentation
You can find the full reference on Algolia’s website.
Getting Started
Install
Install AlgoliaSearch using pip:
pip install --upgrade algoliasearch
Quick Start
In 30 seconds, this quick start tutorial will show you how to index and search objects.
Initialize the client
To begin, you will need to initialize the client. In order to do this you will need your Application ID and API Key. You can find both on your Algolia account.
from algoliasearch import algoliasearch client = algoliasearch.Client("YourApplicationID", 'YourAPIKey') index = client.init_index('your_index_name')
Note: If you use this API Client with Google AppEngine (Thanks [@apassant](https://github.com/apassant)), it will use urlfetch instead of using the request module. Please be aware of urlfetch’s limits, and note that SSL certificates will not be verified for calls to domains other than algolia.net due to the lack of SNI support in urlfetch. To run unit tests on the AppEngine stub, please define an APPENGINE_RUNTIME enviroment variable.
Push data
Without any prior configuration, you can start indexing 500 contacts in the contacts index using the following code:
index = client.init_index("contact") batch = json.load(open('contacts.json')) index.add_objects(batch)
Configure
Settings can be customized to fine tune the search behavior. For example, you can add a custom sort by number of followers to further enhance the built-in relevance:
index.set_settings({"customRanking": ["desc(followers)"]})
You can also configure the list of attributes you want to index by order of importance (most important first).
Note: The Algolia engine is designed to suggest results as you type, which means you’ll generally search by prefix. In this case, the order of attributes is very important to decide which hit is the best:
index.set_settings({"searchableAttributes": ["lastname", "firstname", "company", "email", "city", "address"]})
Search
You can now search for contacts using firstname, lastname, company, etc. (even with typos):
# search by firstname print index.search("jimmie") # search a firstname with typo print index.search("jimie") # search for a company print index.search("california paint") # search for a firstname & company print index.search("jimmie paint")
Search UI
Warning: If you are building a web application, you may be more interested in using one of our frontend search UI libraries
The following example shows how to build a front-end search quickly using InstantSearch.js
index.html
<!doctype html> <head> <meta charset="UTF-8"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.css"> <!-- Always use `2.x` versions in production rather than `2` to mitigate any side effects on your website, Find the latest version on InstantSearch.js website: https://community.algolia.com/instantsearch.js/v2/guides/usage.html --> </head> <body> <header> <div> <input id="search-input" placeholder="Search for products"> <!-- We use a specific placeholder in the input to guides users in their search. --> </header> <main> </main> <script type="text/html" id="hit-template"> <p class="hit-name">{{{_highlightResult.firstname.value}}} {{{_highlightResult.lastname.value}}}</p> </script> <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.js"></script> <script src="app.js"></script> </body>
app.js
var search = instantsearch({ // Replace with your own values appId: 'YourApplicationID', apiKey: 'YourSearchOnlyAPIKey', // search only API key, no ADMIN key indexName: 'contacts', urlSync: true, searchParameters: { hitsPerPage: 10 } }); search.addWidget( instantsearch.widgets.searchBox({ container: '#search-input' }) ); search.addWidget( instantsearch.widgets.hits({ container: '#hits', templates: { item: document.getElementById('hit-template').innerHTML, empty: "We didn't find any results for the search <em>\"{{query}}\"</em>" } }) ); search.start();
List of available methods
Indexing
Settings
Manage indices
API Keys
Synonyms
Query rules
MultiClusters
Getting Help
- Need help? Ask a question to the Algolia Community or on Stack Overflow.
- Found a bug? You can open a GitHub issue.
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size & hash SHA256 hash help | File type | Python version | Upload date |
|---|---|---|---|
| algoliasearch-1.17.0-py2.py3-none-any.whl (26.6 kB) Copy SHA256 hash SHA256 | Wheel | 3.6 | Jun 19, 2018 |
| algoliasearch-1.17.0.tar.gz (28.6 kB) Copy SHA256 hash SHA256 | Source | None | Jun 19, 2018 |
