MeiliSearch DSL is a Python package providing a Django-like Q object syntax for querying MeiliSearch, an open-source search engine. It simplifies search query building and offers a convenient wrapper for MeiliSearch indexes and clients, streamlining search interactions and improving maintainability.
Project description
MeiliSearch DSL
MeiliSearch DSL is a powerful and easy-to-use Python package that provides a domain-specific language (DSL) for querying MeiliSearch, an open-source search engine. With this package, you can effortlessly build complex search queries using a Django-like Q object syntax. It also includes a convenient wrapper for MeiliSearch indexes and client, making it even simpler to interact with your MeiliSearch instance. Whether you're a beginner or an experienced developer, MeiliSearch DSL can streamline your search experience and help you create efficient, readable, and maintainable search queries.
Features
- Django-like Q object syntax for building complex search queries
- Convenient wrapper for MeiliSearch indexes and clients
- Easy integration with MeiliSearch instances
- Streamlined search interactions
- Improved code readability and maintainability
Installation
Install the package using pip:
pip install meilisearch-dsl
Usage
To use MeiliSearch DSL, first import the necessary components:
from meilisearch_dsl import Q, MeiliClient, MeiliIndex
# Then, create a MeiliSearch client and index:
client = MeiliClient(host="http://127.0.0.1:7700", master_key="your_master_key")
index = client.get_index("your_index_name")
# or
index = MeiliIndex("your_index_name", client)
# Build a search filter using the Q object syntax:
filter = ( Q(category__in=["programming", "software"])) & ~Q(price__gt=50)
# Search the index using the filter:
query="Python"
results = index.search(query, filter)
print(results)
Documentation
For more detailed information and examples, please refer to the official documentation.
Contributing
We welcome contributions from the community! Please read our contribution guidelines before submitting a pull request.
License
MeiliSearch DSL is 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file meilisearchdsl-0.1.7.tar.gz.
File metadata
- Download URL: meilisearchdsl-0.1.7.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
89f4678de9e795e26741eeeb5e567a9fd47de6f85f287ae7a3a93868fcdc8f4e
|
|
| MD5 |
b180eed026af15c8bfc48e5be88dc17d
|
|
| BLAKE2b-256 |
b7ef2efbc6a911de9ba9274ac748f14a34cfef4feb81736a670a3f7b3c548cbc
|
File details
Details for the file meilisearchdsl-0.1.7-py3-none-any.whl.
File metadata
- Download URL: meilisearchdsl-0.1.7-py3-none-any.whl
- Upload date:
- Size: 12.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d9cc149415652e05ab543852440561560f107fe4dc7bf534f54dce3b89ab7f8
|
|
| MD5 |
b57d62710ca46d25438db7cd7099f060
|
|
| BLAKE2b-256 |
ed0789dc576d4d0be328c98d730e24970f26f5d3147a8a6c854eef1944ac4962
|