{"id":20528255,"url":"https://github.com/manticoresoftware/manticoresearch-python","last_synced_at":"2025-04-14T04:51:12.515Z","repository":{"id":44635869,"uuid":"288164342","full_name":"manticoresoftware/manticoresearch-python","owner":"manticoresoftware","description":"Official Python client for Manticore Search","archived":false,"fork":false,"pushed_at":"2024-04-13T09:27:32.000Z","size":354,"stargazers_count":32,"open_issues_count":1,"forks_count":7,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-14T06:48:14.721Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manticoresoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-08-17T11:39:51.000Z","updated_at":"2024-04-18T07:27:18.261Z","dependencies_parsed_at":"2024-04-18T07:27:11.737Z","dependency_job_id":"725cc8a0-513b-4c9a-a63c-522dea022362","html_url":"https://github.com/manticoresoftware/manticoresearch-python","commit_stats":{"total_commits":40,"total_committers":3,"mean_commits":"13.333333333333334","dds":"0.44999999999999996","last_synced_commit":"49d62ad96df0d4cd179cf5229fadd7a30c1c5b8f"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manticoresoftware","download_url":"https://codeload.github.com/manticoresoftware/manticoresearch-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248824693,"owners_count":21167343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T23:24:10.707Z","updated_at":"2025-04-14T04:51:12.509Z","avatar_url":"https://github.com/manticoresoftware.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Manticore Python client\n\nСlient for Manticore Search.\n\n\n❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-python/tree/8.0.0\n\n## Requirements.\n\nMinimum Manticore Search version is \u003e= 2.5.1 with HTTP protocol enabled.\n\n| **manticoresearch-python*   | **Manticore Search**                | **Python**     | **Compatibility**       |\n| --------------------------- | ----------------------------------- | -------------- | ------------------------|\n| `manticoresearch-devel`     | `dev` (latest development version)  | 3.4 or newer   | ✅ Fully Compatible     |\n| 8.0.0 or newer              | 9.2.14 or newer                     | 3.4 or newer   | ✅ Fully Compatible     |\n| 6.0.0 to 8.0.0              | 9.2.14 or newer                     | 3.4 or newer   | ⚠️ Partially Compatible |\n| 6.0.0 to 8.0.0              | 7.0.0 to 9.2.14                     | 3.4 or newer   | ✅ Fully Compatible     |\n| 6.0.0 or newer              | 6.2.1 to 7.0.0                      | 3.4 or newer   | ⚠️ Partially Compatible |\n| 3.3.1 to 6.0.0              | 7.0.0 or newer                      | 3.4 or newer   | ⚠️ Partially Compatible |\n| 3.3.1 to 6.0.0              | 6.2.1 to 7.0.0                      | 3.4 or newer   | ✅ Fully Compatible     |\n| 2.0.0 to 3.3.1              | 6.2.0 or newer                      | 3.4 or newer   | ⚠️ Partially Compatible |\n| 2.0.0 to 3.3.1              | 4.2.1 to 6.2.0                      | 3.4 or newer   | ✅ Fully Compatible     |\n| 1.0.6 to 2.0.0              | 4.0.2 to 4.2.1                      | 3.4 or newer   | ✅ Fully Compatible     |\n| 1.0.5 to 1.0.6              | 4.0.2 to 4.2.1                      | 2.7 or newer   | ⚠️ Partially Compatible |\n| 1.0.5 to 1.0.6              | 2.5.1 to 4.0.2                      | 2.7 or newer   | ✅ Fully Compatible     |\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/manticoresoftware/manticoresearch-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/manticoresoftware/manticoresearch-python.git`)\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\nimport manticoresearch\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 instances of API classes\n    indexApi = manticoresearch.IndexApi(api_client)\n    searchApi = manticoresearch.SearchApi(api_client)\n    utilsApi = manticoresearch.UtilsApi(api_client)\n\n    try:\n        # Perform insert and search operations    \n        newDoc = {\"title\" : \"Crossbody Bag with Tassel\", \"price\": 19.85}\n        insert_request = InsertDocumentRequest(index=\"products\", doc=newDoc)\n        indexApi.insert(insert_request)\n        \n        # Check out the structure of the autocreated 'products' table\n        sql_response = utilsApi.sql('DESC products');\n        print(\"The response of UtilsApi-\u003esql:\\n\")\n        pprint(sql_response) \n\n        newDoc = {\"title\" : \"Pet Hair Remover Glove\", \"price\": 7.99}\n        insert_request = InsertDocumentRequest(index=\"products\", doc=newDoc)\n        indexApi.insert(insert_request)\n        \n        query_highlight = Highlight()\n        query_highlight.fields = {\"title\":{}}\n        search_query = SearchQuery(query_string=\"@title bag\")\n        search_request = SearchRequest(index=\"products\", query=search_query, highlight=query_highlight)\n        search_response = searchApi.search(search_request)    \n        print(\"The response of SearchApi-\u003esearch:\\n\")\n        pprint(search_response)\n\n        # Alternatively, you can pass all request arguments as a complex JSON object        \n        indexApi.insert({\"index\": \"products\", \"doc\" : {\"title\" : \"Crossbody Bag with Tassel\", \"price\" : 19.85}})\n        indexApi.insert({\"index\": \"products\", \"doc\" : {\"title\" : \"Pet Hair Remover Glove\", \"price\" : 7.99}})\n        search_response = searchApi.search({\"index\": \"products\", \"query\": {\"query_string\": \"@title bag\"}, \"highlight\":{\"fields\":{\"title\":{}}}})\n        print(\"The response of SearchApi-\u003esearch:\\n\")\n        pprint(search_response)\n    except ApiException as e:\n        print(\"Exception when calling Api method: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://127.0.0.1:9308*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /bulk | Bulk table operations\n*IndexApi* | [**delete**](docs/IndexApi.md#delete) | **POST** /delete | Delete a document in a table\n*IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /insert | Create a new document in a table\n*IndexApi* | [**partial_replace**](docs/IndexApi.md#partial_replace) | **POST** /{table}/_update/{id} | Partially replaces a document in a table\n*IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /replace | Replace new document in a table\n*IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /update | Update a document in a table\n*SearchApi* | [**autocomplete**](docs/SearchApi.md#autocomplete) | **POST** /autocomplete | Performs an autocomplete search on a table\n*SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /pq/{table}/search | Perform reverse search on a percolate table\n*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search on a table\n*UtilsApi* | [**sql**](docs/UtilsApi.md#sql) | **POST** /sql | Perform SQL requests\n\n\n## Documentation For Models\n\n - [AggComposite](docs/AggComposite.md)\n - [AggCompositeSource](docs/AggCompositeSource.md)\n - [AggCompositeTerm](docs/AggCompositeTerm.md)\n - [AggTerms](docs/AggTerms.md)\n - [Aggregation](docs/Aggregation.md)\n - [AutocompleteRequest](docs/AutocompleteRequest.md)\n - [BoolFilter](docs/BoolFilter.md)\n - [BulkResponse](docs/BulkResponse.md)\n - [DeleteDocumentRequest](docs/DeleteDocumentRequest.md)\n - [DeleteResponse](docs/DeleteResponse.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [FulltextFilter](docs/FulltextFilter.md)\n - [GeoDistance](docs/GeoDistance.md)\n - [GeoDistanceLocationAnchor](docs/GeoDistanceLocationAnchor.md)\n - [Highlight](docs/Highlight.md)\n - [HighlightFieldOption](docs/HighlightFieldOption.md)\n - [HitsHits](docs/HitsHits.md)\n - [InsertDocumentRequest](docs/InsertDocumentRequest.md)\n - [Join](docs/Join.md)\n - [JoinCond](docs/JoinCond.md)\n - [JoinOn](docs/JoinOn.md)\n - [KnnQuery](docs/KnnQuery.md)\n - [Match](docs/Match.md)\n - [MatchAll](docs/MatchAll.md)\n - [PercolateRequest](docs/PercolateRequest.md)\n - [PercolateRequestQuery](docs/PercolateRequestQuery.md)\n - [QueryFilter](docs/QueryFilter.md)\n - [Range](docs/Range.md)\n - [ReplaceDocumentRequest](docs/ReplaceDocumentRequest.md)\n - [ResponseError](docs/ResponseError.md)\n - [ResponseErrorDetails](docs/ResponseErrorDetails.md)\n - [SearchQuery](docs/SearchQuery.md)\n - [SearchRequest](docs/SearchRequest.md)\n - [SearchResponse](docs/SearchResponse.md)\n - [SearchResponseHits](docs/SearchResponseHits.md)\n - [SourceRules](docs/SourceRules.md)\n - [SqlObjResponse](docs/SqlObjResponse.md)\n - [SqlResponse](docs/SqlResponse.md)\n - [SuccessResponse](docs/SuccessResponse.md)\n - [UpdateDocumentRequest](docs/UpdateDocumentRequest.md)\n - [UpdateResponse](docs/UpdateResponse.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\ninfo@manticoresearch.com\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-python/lists"}