| Name | pymeilisearch JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | A Python library for effortless indexing and searching of documentation using MeiliSearch. |
| upload_time | 2023-10-11 14:39:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8,<4 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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
Raw data
{
"_id": null,
"home_page": "",
"name": "pymeilisearch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "PyAnsys Core Team <pyansys.core@ansys.com>",
"keywords": "",
"author": "",
"author_email": "\"ANSYS, Inc.\" <pyansys.core@ansys.com>",
"download_url": "https://files.pythonhosted.org/packages/83/e2/506f4f8282f9d79d7a7c650a76e2f00512aa3b701a26ac9acda5ad31aa8d/pymeilisearch-0.3.1.tar.gz",
"platform": null,
"description": "PyMeilisearch\n#############\n\n**An enhanced Python API to Meilisearch**\n\n|ansys| |python| |pypi| |GH-CI| |MIT| |black|\n\n.. |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\n :target: https://actions.docs.ansys.com/\n :alt: PyAnsys\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/pymeilisearch?logo=pypi\n :target: https://pypi.org/project/pymeilisearch/\n :alt: Python\n\n.. |pypi| image:: https://img.shields.io/pypi/v/pymeilisearch.svg?logo=python&logoColor=white\n :target: https://pypi.org/project/pymeilisearch\n :alt: PyPI\n\n.. |GH-CI| image:: https://github.com/ansys/pymeilisearch/actions/workflows/ci_cd.yml/badge.svg\n :target: https://github.com/ansys/pymeilisearch/actions/workflows/ci_cd.yml\n :alt: GH-CI\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: MIT\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat\n :target: https://github.com/psf/black\n :alt: Black\n\n\nAbout\n=====\n\nPyMeilisearch is a Python command-line interface (CLI) that\nsimplifies integration with `Meilisearch <https://www.meilisearch.com/>`_,\nenabling developers to enhance their applications with powerful search\nfunctionality by indexing desired data.\n\nPyMeilisearch provides these key features:\n\n- **Easy integration** with continuous integration workflows.\n\n- **High-level functionality** for indexing data, performing searches, and managing documents.\n\n- **Powerful capabilities** for enabling filtering options and indexing\n configurations for tailored search experiences.\n\n\nInstallation\n============\n\nInstalling the ``pymeilisearch`` package is as easy as running this command:\n\n.. code-block:: console\n\n python -m pip install pymeilisearch\n\nFor other installation methods, refer to `PyMeilisearch installation\n<https://pymeilisearch.docs.ansys.com/version/stable/getting-started/installing-pymeilisearch.html>`_\nin the PyMeilisearch documentation.\n\n\nDocumentation\n=============\n\nThe `PyMeilisearch documentation`_ contains these sections:\n\n- `Getting started`_: Describes how to install PyMeilisearch\n and build your own Docker image for testing PyMeilisearch locally.\n\n- `User guide`_: Describes how to use the PyMeilisearch CLI and\n integrate PyMeilisearch in a website.\n\n- `API reference`_: Describes the PyMeilisearch API. For each\n subpackage and submodule, it provides information about classes, functions,\n methods, parameters, and return values. This reference helps you understand the\n available API endpoints, their capabilities, and how to interact with them\n programmatically.\n\n- `Examples`_: Provides code examples that show how to use PyMeilisearch\n in real-world scenarios. Sample code snippets and complete scripts\n demonstrate different use cases or specific features to help you\n understand how to use PyMeilisearch in your own projects.\n\n.. _PyMeilisearch Installation documentation: https://pymeilisearch.docs.ansys.com/version/stable/getting-started/installing-pymeilisearch.html\n.. _PyMeilisearch documentation: https://pymeilisearch.docs.ansys.com\n.. _getting started: https://pymeilisearch.docs.ansys.com/version/stable/getting-started/index.html\n.. _user guide: https://pymeilisearch.docs.ansys.com/version/stable/user-guide/index.html\n.. _api reference: https://pymeilisearch.docs.ansys.com/version/stable/autoapi/index.html\n.. _examples: https://pymeilisearch.docs.ansys.com/version/stable/examples/index.html\n\n\nTroubleshooting\n===============\n\nTo request troubleshooting assistance or report an issue, follow these steps to\ncreate an issue in the project's repository:\n\n#. Go to the `PyMeilisearch repository`_.\n#. Click the **Issues** tab to view the **Issues** page.\n#. On the **Issues** page, click **New Issue**.\n#. In the window that opens, provide a clear and detailed description of the issue\n that you are facing. Include any relevant error messages, code snippets, and\n screenshots.\n\nTo reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.\n\n\nLicense and acknowledgements\n============================\n\nPyMeilisearch is licensed under the MIT license.\nYou can see the full text of the license in the `LICENSE` file.\n\n.. _license: https://github.com/ansys/pymeilisearch/blob/main/LICENSE\n.. _PyMeilisearch repository: https://github.com/ansys/pymeilisearch\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python library for effortless indexing and searching of documentation using MeiliSearch.",
"version": "0.3.1",
"project_urls": {
"Discussions": "https://github.com/ansys/pymeilisearch/discussions",
"Documentation": "https://pymeilisearch.docs.ansys.com",
"Homepage": "https://github.com/ansys/pymeilisearch",
"Releases": "https://github.com/ansys/pymeilisearch/releases",
"Source": "https://github.com/ansys/pymeilisearch",
"Tracker": "https://github.com/ansys/pymeilisearch/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dacba4635cce2509de91681bfcb20e6dd89172340f5d5059702484488e9285a5",
"md5": "90e6899e3896a2c547056929559fa64c",
"sha256": "b1ba63077516501aea422185fd82160cd2e7593033a4a70a5e4da903c248b79f"
},
"downloads": -1,
"filename": "pymeilisearch-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90e6899e3896a2c547056929559fa64c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 20740,
"upload_time": "2023-10-11T14:39:52",
"upload_time_iso_8601": "2023-10-11T14:39:52.529298Z",
"url": "https://files.pythonhosted.org/packages/da/cb/a4635cce2509de91681bfcb20e6dd89172340f5d5059702484488e9285a5/pymeilisearch-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83e2506f4f8282f9d79d7a7c650a76e2f00512aa3b701a26ac9acda5ad31aa8d",
"md5": "8450af9ceb6939ba9c6b664ec996a5da",
"sha256": "d856b3079339fb5b6c2624524fa8102061d3bd1a09d4f033426c400aa20b2a88"
},
"downloads": -1,
"filename": "pymeilisearch-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "8450af9ceb6939ba9c6b664ec996a5da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 17176,
"upload_time": "2023-10-11T14:39:55",
"upload_time_iso_8601": "2023-10-11T14:39:55.048720Z",
"url": "https://files.pythonhosted.org/packages/83/e2/506f4f8282f9d79d7a7c650a76e2f00512aa3b701a26ac9acda5ad31aa8d/pymeilisearch-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-11 14:39:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansys",
"github_project": "pymeilisearch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pymeilisearch"
}
