# 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 |
| ----------------- | ------------------------ | ------------- |
| dev | manticoresearch-devel | >= 3.4 |
| >= 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-devel
```
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": null,
"name": "manticoresearch-devel",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "full-text search, manticoresearch, search",
"author": "Manticore Software Ltd.",
"author_email": "info@manticoresearch.com",
"download_url": "https://files.pythonhosted.org/packages/72/86/e2725a8f9cc419de691c5c0cef1783a17b6639fdf839e8daaf8d160e1c02/manticoresearch-devel-4.3.24041813.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| dev | manticoresearch-devel | >= 3.4 |\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-devel\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.3.24041813",
"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": "f08c6d4de87493859ce8d7a8fa55a6511a8b5c228f93d210008123c35fbcce3c",
"md5": "bcc8263e32bebc81d4ea85cf9edc6bea",
"sha256": "139957eeb17dabcdc73714c4101f1a333c0b1576ba0194ab6a6f5736bbf22870"
},
"downloads": -1,
"filename": "manticoresearch_devel-4.3.24041813-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bcc8263e32bebc81d4ea85cf9edc6bea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 125213,
"upload_time": "2024-04-18T06:09:26",
"upload_time_iso_8601": "2024-04-18T06:09:26.368103Z",
"url": "https://files.pythonhosted.org/packages/f0/8c/6d4de87493859ce8d7a8fa55a6511a8b5c228f93d210008123c35fbcce3c/manticoresearch_devel-4.3.24041813-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7286e2725a8f9cc419de691c5c0cef1783a17b6639fdf839e8daaf8d160e1c02",
"md5": "f9e47ee3f2e9d78b2686d7608a949f1f",
"sha256": "01b80cdebe2a095fc0261a3dee2c9e2c0d92fd543c9424305f6d9521f66dee8e"
},
"downloads": -1,
"filename": "manticoresearch-devel-4.3.24041813.tar.gz",
"has_sig": false,
"md5_digest": "f9e47ee3f2e9d78b2686d7608a949f1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 68070,
"upload_time": "2024-04-18T06:09:28",
"upload_time_iso_8601": "2024-04-18T06:09:28.066005Z",
"url": "https://files.pythonhosted.org/packages/72/86/e2725a8f9cc419de691c5c0cef1783a17b6639fdf839e8daaf8d160e1c02/manticoresearch-devel-4.3.24041813.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 06:09:28",
"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-devel"
}