# Manticore Python client
Сlient for Manticore Search.
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-python/tree/4.0.0
## Requirements.
Minimum Manticore Search version is >= 2.5.1 with HTTP protocol enabled.
| Manticore Search | manticoresearch-python | Python |
| ----------------- | ------------------------ | ------------- |
| >= 6.2.0 | >= 3.3.1 | >= 3.4 |
| >= 4.2.1 | >= 2.0.x | >= 3.4 |
| >= 4.0.2 < 4.2.1 | >= 1.0.6 | >= 3.4 |
| >= 2.5.1 < 4.0.2 | >= 1.0.5 | >= 2.7 |
## Installation & Usage
### pip install
Install the `manticoresearch` package with [pip](http://pypi.python.org)
```sh
pip install manticoresearch-dev
```
Then import the package:
```python
import manticoresearch
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import manticoresearch
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import manticoresearch
from manticoresearch import *
from manticoresearch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://127.0.0.1:9308
# See configuration.py for a list of all supported configuration parameters.
configuration = manticoresearch.Configuration(
host = "http://127.0.0.1:9308"
)
# Enter a context with an instance of the API client
with manticoresearch.ApiClient(configuration) as api_client:
# Create an instance of the IndexApi API class
api_instance = manticoresearch.IndexApi(api_client)
body = "["'{\"insert\": {\"index\": \"test\", \"id\": 1, \"doc\": {\"title\": \"Title 1\"}}},\\n{\"insert\": {\"index\": \"test\", \"id\": 2, \"doc\": {\"title\": \"Title 2\"}}}'"]" # str |
try:
# Bulk index operations
api_response = api_instance.bulk(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IndexApi->bulk: %s\n" % e)
# Create an instance of the Search API class
api_instance = manticoresearch.SearchApi(api_client)
# Create SearchRequest
search_request = SearchRequest()
search_request.index='test'
search_request.fullltext_filter=QueryFilter('Title 1')
# The example passes only required values which don't have defaults set
try:
# Perform a search
api_response = api_instance.search(search_request)
pprint(api_response)
except manticoresearch.ApiException as e:
print("Exception when calling SearchApi->search: %s\n" % e)
```
# Documentation
Full documentation on the API Endpoints and Models used is available in [docs](https://github.com/manticoresoftware/manticoresearch-python/tree/master/docs) folder as listed below.
Manticore Search server documentation: https://manual.manticoresearch.com.
Raw data
{
"_id": null,
"home_page": "",
"name": "manticoresearch-dev",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "full-text search,manticoresearch,search",
"author": "Manticore Software Ltd.",
"author_email": "info@manticoresearch.com",
"download_url": "https://files.pythonhosted.org/packages/41/09/41d3798e1da5d00cfe6df70b985febaef2a279d84c8959e18124c41c32e1/manticoresearch-dev-4.1.24030713.tar.gz",
"platform": null,
"description": "# Manticore Python client\n\n\u0421lient for Manticore Search.\n\n\u2757 WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-python/tree/4.0.0\n\n## Requirements.\n\nMinimum Manticore Search version is >= 2.5.1 with HTTP protocol enabled.\n\n| Manticore Search | manticoresearch-python | Python |\n| ----------------- | ------------------------ | ------------- |\n| >= 6.2.0 | >= 3.3.1 | >= 3.4 |\n| >= 4.2.1 | >= 2.0.x | >= 3.4 |\n| >= 4.0.2 < 4.2.1 | >= 1.0.6 | >= 3.4 |\n| >= 2.5.1 < 4.0.2 | >= 1.0.5 | >= 2.7 |\n\n## Installation & Usage\n### pip install\nInstall the `manticoresearch` package with [pip](http://pypi.python.org)\n\n```sh\npip install manticoresearch-dev\n```\n\nThen import the package:\n```python\nimport manticoresearch\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport manticoresearch\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport manticoresearch\nfrom manticoresearch import *\nfrom manticoresearch.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://127.0.0.1:9308\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = manticoresearch.Configuration(\n host = \"http://127.0.0.1:9308\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith manticoresearch.ApiClient(configuration) as api_client:\n # Create an instance of the IndexApi API class\n api_instance = manticoresearch.IndexApi(api_client)\n body = \"[\"'{\\\"insert\\\": {\\\"index\\\": \\\"test\\\", \\\"id\\\": 1, \\\"doc\\\": {\\\"title\\\": \\\"Title 1\\\"}}},\\\\n{\\\"insert\\\": {\\\"index\\\": \\\"test\\\", \\\"id\\\": 2, \\\"doc\\\": {\\\"title\\\": \\\"Title 2\\\"}}}'\"]\" # str | \n\n try:\n # Bulk index operations\n api_response = api_instance.bulk(body)\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling IndexApi->bulk: %s\\n\" % e)\n \n \n # Create an instance of the Search API class\n api_instance = manticoresearch.SearchApi(api_client)\n\n # Create SearchRequest\n search_request = SearchRequest()\n search_request.index='test'\n search_request.fullltext_filter=QueryFilter('Title 1') \n \n # The example passes only required values which don't have defaults set\n try:\n # Perform a search\n api_response = api_instance.search(search_request)\n pprint(api_response)\n except manticoresearch.ApiException as e:\n print(\"Exception when calling SearchApi->search: %s\\n\" % e)\n```\n\n# Documentation\n\n\nFull documentation on the API Endpoints and Models used is available in [docs](https://github.com/manticoresoftware/manticoresearch-python/tree/master/docs) folder as listed below.\n\nManticore Search server documentation: https://manual.manticoresearch.com.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for Manticore Search",
"version": "4.1.24030713",
"project_urls": {
"Documentation": "https://github.com/manticoresoftware/manticoresearch-python/tree/master/docs",
"Issue Tracker": "https://github.com/manticoresoftware/manticoresearch-python/issues",
"Source Code": "https://github.com/manticoresoftware/manticoresearch-python"
},
"split_keywords": [
"full-text search",
"manticoresearch",
"search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89a5e7976a4164d67181be7704ee2e4189a4de7380a72b22748c2d32405b59fa",
"md5": "c7e6b8979e49a2fa0bc31b9e2ddd0e2e",
"sha256": "5aff582658a70a58b5875a5d9c72c5f5f94655317a205ebaf6aa7182ef32b72d"
},
"downloads": -1,
"filename": "manticoresearch_dev-4.1.24030713-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7e6b8979e49a2fa0bc31b9e2ddd0e2e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 119935,
"upload_time": "2024-03-07T06:23:22",
"upload_time_iso_8601": "2024-03-07T06:23:22.474232Z",
"url": "https://files.pythonhosted.org/packages/89/a5/e7976a4164d67181be7704ee2e4189a4de7380a72b22748c2d32405b59fa/manticoresearch_dev-4.1.24030713-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "410941d3798e1da5d00cfe6df70b985febaef2a279d84c8959e18124c41c32e1",
"md5": "efd91a3216ab189fab217c8a879f3de8",
"sha256": "e08c6d2020d118d243651281ed5e82f8d7425347bdc564ea504090afb32d650f"
},
"downloads": -1,
"filename": "manticoresearch-dev-4.1.24030713.tar.gz",
"has_sig": false,
"md5_digest": "efd91a3216ab189fab217c8a879f3de8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 66933,
"upload_time": "2024-03-07T06:23:24",
"upload_time_iso_8601": "2024-03-07T06:23:24.296583Z",
"url": "https://files.pythonhosted.org/packages/41/09/41d3798e1da5d00cfe6df70b985febaef2a279d84c8959e18124c41c32e1/manticoresearch-dev-4.1.24030713.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-07 06:23:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "manticoresoftware",
"github_project": "manticoresearch-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "manticoresearch-dev"
}
JSON
