# ELO Indexserver Client
Developed by [Treskon GmbH](https://treskon.at/)
* published on PyPI: https://pypi.org/project/elo-indexserver-client/
* [Documentation](https://treskon.github.io/elo-indexserver-client/)
* Sourcecode [GitHub repository](https://github.com/treskon/elo-indexserver-client)
A client library for accessing Indexserver component of [ELO Digital Office GmbH](https://www.elo.com/de-at.html) via
REST API.
## Motivation
The 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.**
## Installation
```bash
pip install elo-indexserver-client
```
## Usage
First, init the Service with the baseurl, user and password of the Indexserver REST API.
```python
from eloservice.elo_service import EloService
rest_baseurl = "http://localhost:9090/ix-Archive/rest/"
rest_user = "elo"
rest_password = "elo"
elo_service = EloService(url=rest_baseurl, user=rest_user, password=rest_password)
```
**Known issue: Due to encoding issues the user and password should not contain special characters.**
Then you can use the service to access the Index server REST API.
Here are often examples:
```python
# Create Folder
folder_id = elo_service.create_folder(path="¶Foodplaces", separator="¶")
# upload_file
file_id = elo_service.upload_file(sord_id=folder_id, file_path="test.jpg", file_name="ichiran_ramen.jpg")
# overwrite_mask_fields
elo_service.overwrite_mask_fields(sord_id=file_id, mask_name="Images", metadata={
"LATITUDE": "35.73258119685775",
"LONGITUDE": "139.71412884357233",
"ITEMDOCDATE": "2023-12-26"
})
# search
search_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 the [Documentation](https://treskon.github.io/elo-indexserver-client/) or see the
docstrings in the code.
There are also some demos via juptyer notebook in the examples folder.
See [Readme](examples/Readme.md) for more information.
## Technical Details
The client library is based on the OpenAPI specification provided by ELO Indexserver. Downloaded from the ELO Server
under the url http://eloIndexServer:9090/ix/resources/openapi.json.
The used ELO version was 20.0.0.111.
Based on the OpenAPI specification, the client library was generated using
the [openapi-python-client tool](https://github.com/openapi-generators/openapi-python-client).
## Contributing and Support
We are happy to receive any contributions to this library. Feel free to open an issue or a pull request in our
[GitHub repository](https://github.com/treskon/elo-indexserver-client). To get started read the [Contributing Guide](CONTRIBUTING.md).
We'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 open an issue in our [GitHub repository](https://github.com/treskon/elo-indexserver-client) or contact us
via mail at: internal-dev@treskon.at.
## License
Copyright 2024 Treskon GmbH
Licensed 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 at
http://www.apache.org/licenses/LICENSE-2.0
Unless 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/treskon/elo-indexserver-client",
"name": "elo-indexserver-client",
"maintainer": "Treskon GmbH",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "internal-dev@treskon.at",
"keywords": null,
"author": "Manuel Eiweck",
"author_email": "manuel.eiweck@treskon.at",
"download_url": "https://files.pythonhosted.org/packages/0a/74/df7360719561ccd937fad4cf8c7d5a730ff4dc28dd31b0fadd93e3954310/elo_indexserver_client-0.1.21.tar.gz",
"platform": null,
"description": "# ELO Indexserver Client\n\nDeveloped by [Treskon GmbH](https://treskon.at/) \n* published on PyPI: https://pypi.org/project/elo-indexserver-client/ \n* [Documentation](https://treskon.github.io/elo-indexserver-client/)\n* Sourcecode [GitHub repository](https://github.com/treskon/elo-indexserver-client)\n\nA client library for accessing Indexserver component of [ELO Digital Office GmbH](https://www.elo.com/de-at.html) via\nREST API.\n\n## Motivation\n\nThe motivation for this project was to provide a simple and easy to use client library for accessing the Indexserver\nREST API.\nWhile ELO provides an OpenAPI specification for the Indexserver REST API, it appears to be a port of the Java SDK.\nWhich allows to use all the features of the Java SDK, similar to what we could do in the ELO Java Client itself.\nThis comes in favor for people who already have experience in working with the ELO Java SDK.\nHowever, for people who are not familiar with the ELO ecosystem the naming conventions, structure, method names, BSET\nFlags, etc. are far from intuitive and easy to understand.\n\n**Therefore, we decided to create a client library that wraps the original OpenAPI specification and exposes only a\nhandful of features that cover the most common use cases.**\n\n## Installation\n\n```bash\npip install elo-indexserver-client\n```\n\n## Usage\n\nFirst, init the Service with the baseurl, user and password of the Indexserver REST API.\n\n```python\nfrom eloservice.elo_service import EloService\n\nrest_baseurl = \"http://localhost:9090/ix-Archive/rest/\"\nrest_user = \"elo\"\nrest_password = \"elo\"\nelo_service = EloService(url=rest_baseurl, user=rest_user, password=rest_password)\n```\n\n**Known issue: Due to encoding issues the user and password should not contain special characters.**\n\nThen you can use the service to access the Index server REST API.\nHere are often examples:\n\n```python\n# Create Folder \nfolder_id = elo_service.create_folder(path=\"\u00b6Foodplaces\", separator=\"\u00b6\")\n# upload_file\nfile_id = elo_service.upload_file(sord_id=folder_id, file_path=\"test.jpg\", file_name=\"ichiran_ramen.jpg\")\n# overwrite_mask_fields\nelo_service.overwrite_mask_fields(sord_id=file_id, mask_name=\"Images\", metadata={\n \"LATITUDE\": \"35.73258119685775\",\n \"LONGITUDE\": \"139.71412884357233\",\n \"ITEMDOCDATE\": \"2023-12-26\"\n})\n# search\nsearch_result = elo_service.search(search_mask_fields={\"LATITUDE\": \"35.73258119685775\"}, max_results=1)\nprint(f\"sordID of the found file: {search_result[0]}\")\n```\n\nFor more information visit the [Documentation](https://treskon.github.io/elo-indexserver-client/) or see the\ndocstrings in the code.\n\nThere are also some demos via juptyer notebook in the examples folder.\nSee [Readme](examples/Readme.md) for more information.\n\n## Technical Details\n\nThe client library is based on the OpenAPI specification provided by ELO Indexserver. Downloaded from the ELO Server\nunder the url http://eloIndexServer:9090/ix/resources/openapi.json.\nThe used ELO version was 20.0.0.111.\n\nBased on the OpenAPI specification, the client library was generated using\nthe [openapi-python-client tool](https://github.com/openapi-generators/openapi-python-client).\n\n## Contributing and Support\n\nWe are happy to receive any contributions to this library. Feel free to open an issue or a pull request in our\n[GitHub repository](https://github.com/treskon/elo-indexserver-client). To get started read the [Contributing Guide](CONTRIBUTING.md).\n\nWe're not able to offer any commercial assistance for this library, but we're always happy to hear your thoughts and\nassist you with any issues, as time permits.\n\nFeel free to open an issue in our [GitHub repository](https://github.com/treskon/elo-indexserver-client) or contact us\nvia mail at: internal-dev@treskon.at.\n\n## License\n\nCopyright 2024 Treskon GmbH\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"bugtrack_url": null,
"license": null,
"summary": "A client library for accessing indexserver REST API of the ECM system ELO Digital Office.",
"version": "0.1.21",
"project_urls": {
"Documentation": "https://treskon.github.io/elo-indexserver-client/",
"Homepage": "https://github.com/treskon/elo-indexserver-client",
"Repository": "https://github.com/treskon/elo-indexserver-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27069fdffd0f949d18711dd53011f207c626613d9733774d0ef0c7f96dcf3016",
"md5": "da665845761b91344717589b40b8bf14",
"sha256": "6e6b440eb7c8346dbbe0fc9f9ca9322d7a967b8bc111ce46be1d23ae95d40622"
},
"downloads": -1,
"filename": "elo_indexserver_client-0.1.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da665845761b91344717589b40b8bf14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 1998324,
"upload_time": "2024-10-22T12:42:05",
"upload_time_iso_8601": "2024-10-22T12:42:05.274185Z",
"url": "https://files.pythonhosted.org/packages/27/06/9fdffd0f949d18711dd53011f207c626613d9733774d0ef0c7f96dcf3016/elo_indexserver_client-0.1.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a74df7360719561ccd937fad4cf8c7d5a730ff4dc28dd31b0fadd93e3954310",
"md5": "abd461dee744dfef49191658ea63b9ba",
"sha256": "5b2b6153df999f00b3747c4a118f7bb9f3e590282a6142fe8acb2b353d50c830"
},
"downloads": -1,
"filename": "elo_indexserver_client-0.1.21.tar.gz",
"has_sig": false,
"md5_digest": "abd461dee744dfef49191658ea63b9ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 712810,
"upload_time": "2024-10-22T12:42:06",
"upload_time_iso_8601": "2024-10-22T12:42:06.673522Z",
"url": "https://files.pythonhosted.org/packages/0a/74/df7360719561ccd937fad4cf8c7d5a730ff4dc28dd31b0fadd93e3954310/elo_indexserver_client-0.1.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 12:42:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "treskon",
"github_project": "elo-indexserver-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "elo-indexserver-client"
}
JSON
