# iDMS
Python class to talk to iDMS REST and Search API within Provincie Zuid-Holland.
# Goal
The goal of the package is to have an easy interface to use the API in Python.
Mainly focussed to work with Content Server 21.4, see [API docs](
https://developer.opentext.com/apis/14ba85a7-4693-48d3-8c93-9214c663edd2/d7540c64-7da2-4554-9966-069c56a9341d/09aaed57-c70b-4092-bace-762b42520293).
# Quick start
## Requirements
1. `pip install idms`
2. `pip install pandas` (optional - for easy data transformation)
3. `pip install openpyxl` (optional - to write to Excel file)
## Sample code
```python
import getpass
import idms.api.contentserver as cs
import pandas # optional
baseUrl = "idms-url"
idms_username = getpass.getpass(prompt='IDMS username:')
idms_password = getpass.getpass(prompt='IDMS password:')
idms = cs.crawler(baseUrl, idms_username, idms_password)
array = idms.search("overdevest prox[1,f] daniel)")
print(f"Found {len(array)} search results")
# optional load results in a data frame to export results.
df = pd.DataFrame(arr)
print(df)
# Export results to Excel
df.to_excel("searchresults.xlsx")
```
# Development
Package is hosted on GitHub. After each change increase version number and create a new Release on GitHub. The pipeline will trigger a release to PyPi (see status batch above).
## Collaborate?
Send a PR!
# Disclaimer
The developers of this package are not affiliated with OpenText.
Raw data
{
"_id": null,
"home_page": "https://github.com/Provincie-Zuid-Holland/idms",
"name": "idms",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5, <4",
"maintainer_email": "",
"keywords": "idms,contentserver,restapi,searchapi",
"author": "Daniel Overdevest, Michael de Winter",
"author_email": "d.overdevest@pzh.nl, mr.de.winter@pzh.nl",
"download_url": "https://files.pythonhosted.org/packages/8e/42/f4adf3c3297b93b2633075412eef7a5e223f784902a8b59e00d9733e72f4/idms-0.2.4.tar.gz",
"platform": null,
"description": "# iDMS\n\n\n\n\nPython class to talk to iDMS REST and Search API within Provincie Zuid-Holland.\n\n# Goal\nThe goal of the package is to have an easy interface to use the API in Python.\n\nMainly focussed to work with Content Server 21.4, see [API docs](\nhttps://developer.opentext.com/apis/14ba85a7-4693-48d3-8c93-9214c663edd2/d7540c64-7da2-4554-9966-069c56a9341d/09aaed57-c70b-4092-bace-762b42520293).\n\n# Quick start\n## Requirements\n1. `pip install idms`\n2. `pip install pandas` (optional - for easy data transformation)\n3. `pip install openpyxl` (optional - to write to Excel file)\n\n## Sample code\n```python\nimport getpass\nimport idms.api.contentserver as cs\nimport pandas # optional\n\nbaseUrl = \"idms-url\"\nidms_username = getpass.getpass(prompt='IDMS username:')\nidms_password = getpass.getpass(prompt='IDMS password:')\nidms = cs.crawler(baseUrl, idms_username, idms_password)\n\narray = idms.search(\"overdevest prox[1,f] daniel)\")\nprint(f\"Found {len(array)} search results\")\n\n# optional load results in a data frame to export results.\ndf = pd.DataFrame(arr)\nprint(df)\n\n# Export results to Excel\ndf.to_excel(\"searchresults.xlsx\")\n```\n\n# Development\nPackage is hosted on GitHub. After each change increase version number and create a new Release on GitHub. The pipeline will trigger a release to PyPi (see status batch above).\n\n## Collaborate?\nSend a PR!\n\n# Disclaimer\nThe developers of this package are not affiliated with OpenText.\n",
"bugtrack_url": null,
"license": "",
"summary": "Python class to talk to idms REST and Search API, better known as iDMS.",
"version": "0.2.4",
"project_urls": {
"Bug Reports": "https://github.com/ProvZH/idms/issues",
"Homepage": "https://github.com/Provincie-Zuid-Holland/idms",
"Source": "https://github.com/ProvZH/idms"
},
"split_keywords": [
"idms",
"contentserver",
"restapi",
"searchapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2106856bf05948815eb809c0846af68d44f06a8a2d14c17284cc88626143a5a6",
"md5": "73d08f034e8b9166746af7b562ebc25f",
"sha256": "e606ab8b978db07fd009673605ded097a77983b09bc37c2232b600adced52fb0"
},
"downloads": -1,
"filename": "idms-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73d08f034e8b9166746af7b562ebc25f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5, <4",
"size": 8908,
"upload_time": "2023-09-26T07:01:21",
"upload_time_iso_8601": "2023-09-26T07:01:21.758901Z",
"url": "https://files.pythonhosted.org/packages/21/06/856bf05948815eb809c0846af68d44f06a8a2d14c17284cc88626143a5a6/idms-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e42f4adf3c3297b93b2633075412eef7a5e223f784902a8b59e00d9733e72f4",
"md5": "64eadbf0e56d406480b3be4019f7589b",
"sha256": "d724ee832dd4d214508b4050d03f8562ac0b94c1d2a60a018c4695e290d282e4"
},
"downloads": -1,
"filename": "idms-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "64eadbf0e56d406480b3be4019f7589b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5, <4",
"size": 11801,
"upload_time": "2023-09-26T07:01:23",
"upload_time_iso_8601": "2023-09-26T07:01:23.547856Z",
"url": "https://files.pythonhosted.org/packages/8e/42/f4adf3c3297b93b2633075412eef7a5e223f784902a8b59e00d9733e72f4/idms-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 07:01:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Provincie-Zuid-Holland",
"github_project": "idms",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "python-dotenv",
"specs": [
[
"==",
"0.15.0"
]
]
}
],
"tox": true,
"lcname": "idms"
}
JSON
