pymeilisearch 0.3.2
A Python library for effortless indexing and searching of documentation using MeiliSearch.
Requires Python: <4,>=3.9

PyMeilisearch
#############

**An enhanced Python API to Meilisearch**

|ansys| |python| |pypi| |GH-CI| |MIT| |black|

.. |ansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
   :target: https://actions.docs.ansys.com/
   :alt: PyAnsys

.. |python| image:: https://img.shields.io/pypi/pyversions/pymeilisearch?logo=pypi
   :target: https://pypi.org/project/pymeilisearch/
   :alt: Python

.. |pypi| image:: https://img.shields.io/pypi/v/pymeilisearch.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/pymeilisearch
   :alt: PyPI

.. |GH-CI| image:: https://github.com/ansys/pymeilisearch/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/ansys/pymeilisearch/actions/workflows/ci_cd.yml
   :alt: GH-CI

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: MIT

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
   :target: https://github.com/psf/black
   :alt: Black


About
=====

PyMeilisearch is a Python command-line interface (CLI) that
simplifies integration with `Meilisearch <https://www.meilisearch.com/>`_,
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:

.. code-block:: console

    python -m pip install pymeilisearch

For other installation methods, refer to `PyMeilisearch installation
<https://pymeilisearch.docs.ansys.com/version/stable/getting-started/installing-pymeilisearch.html>`_
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.

.. _PyMeilisearch Installation documentation: https://pymeilisearch.docs.ansys.com/version/stable/getting-started/installing-pymeilisearch.html
.. _PyMeilisearch documentation: https://pymeilisearch.docs.ansys.com
.. _getting started: https://pymeilisearch.docs.ansys.com/version/stable/getting-started/index.html
.. _user guide: https://pymeilisearch.docs.ansys.com/version/stable/user-guide/index.html
.. _api reference: https://pymeilisearch.docs.ansys.com/version/stable/autoapi/index.html
.. _examples: https://pymeilisearch.docs.ansys.com/version/stable/examples/index.html


Troubleshooting
===============

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

#. Go to the `PyMeilisearch repository`_.
#. Click the **Issues** tab to view the **Issues** page.
#. On the **Issues** page, click **New Issue**.
#. 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 `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.


License and acknowledgements
============================

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

.. _license: https://github.com/ansys/pymeilisearch/blob/main/LICENSE
.. _PyMeilisearch repository: https://github.com/ansys/pymeilisearch