pymeilisearch 0.2.0

A Python library for effortless indexing and searching of documentation using MeiliSearch.

An enhanced Python API to Meilisearch

About

PyMeilisearch is a Python command-line interface (CLI) that simplifies integration with Meilisearch, enabling developers to enhance their applications with powerful search functionality by indexing desired data.

PyMeilisearch provides these key features:

• Easy integration with continuous integration workflows.

• High-level functionality for indexing data, performing searches, and managing documents.

• Powerful capabilities for enabling filtering options and indexing configurations for tailored search experiences.

Installation

Installing the pymeilisearch package is as easy as running this command:

python -m pip install pymeilisearch

For other installation methods, refer to PyMeilisearch installation in the PyMeilisearch documentation.

Documentation

The PyMeilisearch documentation contains these sections:

• Getting started: Describes how to install PyMeilisearch and build your own Docker image for testing PyMeilisearch locally.

• User guide: Describes how to use the PyMeilisearch CLI and integrate PyMeilisearch in a website.

• API reference: Describes the PyMeilisearch API. For each subpackage and submodule, it provides information about classes, functions, methods, parameters, and return values. This reference helps you understand the available API endpoints, their capabilities, and how to interact with them programmatically.

• Examples: Provides code examples that show how to use PyMeilisearch in real-world scenarios. Sample code snippets and complete scripts demonstrate different use cases or specific features to help you understand how to use PyMeilisearch in your own projects.

Troubleshooting

To request troubleshooting assistance or report an issue, follow these steps to create an issue in the project’s repository:

1. Go to the PyMeilisearch repository.

2. Click the Issues tab to view the Issues page.

3. On the Issues page, click New Issue.

4. In the window that opens, provide a clear and detailed description of the issue that you are facing. Include any relevant error messages, code snippets, and screenshots.

To reach the project support team, email [e-mail].

License and acknowledgements

PyMeilisearch is licensed under the MIT license. You can see the full text of the license in the LICENSE file.