Package: elo-indexserver-client
ELO Indexserver ClientDeveloped byTreskon GmbHpublished on PyPI:https://pypi.org/project/elo-indexserver-client/A client library for accessing Indexserver component ofELO Digital Office GmbHvia
REST API.MotivationThe motivation for this project was to provide a simple and easy to use client library for accessing the Indexserver
REST API.
While ELO provides an OpenAPI specification for the Indexserver REST API, it appears to be a port of the Java SDK.
Which allows to use all the features of the Java SDK, similar to what we could do in the ELO Java Client itself.
This comes in favor for people who already have experience in working with the ELO Java SDK.
However, for people who are not familiar with the ELO ecosystem the naming conventions, structure, method names, BSET
Flags, etc. are far from intuitive and easy to understand.Therefore, we decided to create a client library that wraps the original OpenAPI specification and exposes only a
handful of features that cover the most common use cases.Installationpipinstallelo-indexserver-clientUsageFirst, init the Service with the baseurl, user and password of the Indexserver REST API.fromeloservice.elo_serviceimportEloServicerest_baseurl="http://localhost::6056/ix-Archive/rest/"rest_user="elo"rest_password="elo"elo_service=EloService(url=rest_baseurl,user=rest_user,password=rest_password)Then you can use the service to access the Index server REST API.
Here are often examples:# Create Folderfolder_id=elo_service.create_folder(path="¶Foodplaces",separator="¶")# upload_filefile_id=elo_service.upload_file(sord_id=folder_id,file_path="test.jpg",file_name="ichiran_ramen.jpg")# overwrite_mask_fieldselo_service.overwrite_mask_fields(sord_id=file_id,mask_name="Images",metadata={"LATITUDE":"35.73258119685775","LONGITUDE":"139.71412884357233","ITEMDOCDATE":"2023-12-26"})# searchsearch_result=elo_service.search(search_mask_fields={"LATITUDE":"35.73258119685775"},max_results=1)print(f"sordID of the found file:{search_result[0]}")For more information visit theDocumentationor see the
docstrings in the code.Technical DetailsThe client library is based on the OpenAPI specification provided by ELO Indexserver. Downloaded from the ELO Server
under the urlhttp://eloIndexServer:6056/ix/resources/openapi.json.
The used ELO version was 20.0.0.111.Based on the OpenAPI specification, the client library was generated using
theopenapi-python-client tool.Get in touchWe're not able to offer any commercial assistance for this library, but we're always happy to hear your thoughts and
assist you with any issues, as time permits.Feel free to contact us via mail
at:internal-dev@treskon.at.LicenseCopyright 2024 Treskon GmbHLicensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.