The python client for MeiliSearch API.
Project description
MeiliSearch Python
MeiliSearch | Website | Blog | Twitter | Documentation | FAQ
⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Python
MeiliSearch Python is a client for MeiliSearch written in Python. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.
Table of Contents
- 🔧 Installation
- 🚀 Getting started
- 🤖 Compatibility with MeiliSearch
- 📖 Documentation and Examples
- ⚙️ Development Workflow and Contributing
🔧 Installation
With pip3
in command line:
$ pip3 install meilisearch
Run MeiliSearch
There are many easy ways to download and run a MeiliSearch instance.
For example, if you use Docker:
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
NB: you can also download MeiliSearch from Homebrew or APT.
🚀 Getting started
Add documents
import meilisearch
client = meilisearch.Client('http://127.0.0.1:7700', 'masterKey')
index = client.create_index('books') # If your index does not exist
index = client.get_index('books') # If you already created your index
documents = [
{ 'book_id': 123, 'title': 'Pride and Prejudice' },
{ 'book_id': 456, 'title': 'Le Petit Prince' },
{ 'book_id': 1, 'title': 'Alice In Wonderland' },
{ 'book_id': 1344, 'title': 'The Hobbit' },
{ 'book_id': 4, 'title': 'Harry Potter and the Half-Blood Prince' },
{ 'book_id': 42, 'title': 'The Hitchhiker\'s Guide to the Galaxy' }
]
index.add_documents(documents) # => { "updateId": 0 }
With the updateId
, you can check the status (processed
or failed
) of your documents addition thanks to this method.
Search in index
# MeiliSearch is typo-tolerant:
index.search('harry pottre')
Output:
{
"hits" => [{
"book_id" => 4,
"title" => "Harry Potter and the Half-Blood Prince"
}],
"offset" => 0,
"limit" => 20,
"processingTimeMs" => 1,
"query" => "harry pottre"
}
🤖 Compatibility with MeiliSearch
This package only guarantees the compatibility with the version v0.15.0 of MeiliSearch.
📖 Documentation and Examples
MeiliSearch documentation provides examples and a detailed explanation of every one of its features and functionalities, including examples on how to implement them using this SDK.
Please read the guides available in the documentation or check the API references to find the one that you need!
The following sections may interest you:
⚙️ Development Workflow and Contributing
Any new contribution is more than welcome in this project!
If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!
MeiliSearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.
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
Built Distribution
Hashes for meilisearch-0.12.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72b4641bb2cad31d5fdd889cacb7ecfd06522154f85dcbab6dad53dedf4527f7 |
|
MD5 | b0e67823317c50df91417a1f09bb80ec |
|
BLAKE2b-256 | ef8621042b38d6eeaf65ec0b450b8bea9a7c2286f5f2c9bbbe12599e578a2199 |