Python class to talk to idms REST and Search API, better known as iDMS.
Project description
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.
Quick start
Requirements
pip install idms
pip install pandas
(optional - for easy data transformation)pip install openpyxl
(optional - to write to Excel file)
Sample code
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file idms-0.1.20.tar.gz
.
File metadata
- Download URL: idms-0.1.20.tar.gz
- Upload date:
- Size: 10.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe3f8ad14c0611c30bb37880179a0399d4e843fa15fc034892cf5c9fc62a4b1c |
|
MD5 | 5e08592bffb2543fcf87bfd3e3a7b6c3 |
|
BLAKE2b-256 | 4d6d9a53f7cf0148dc4417fde12ea453d576d5f0f0e1f91a3f00f98ae9b3a5a0 |
File details
Details for the file idms-0.1.20-py3-none-any.whl
.
File metadata
- Download URL: idms-0.1.20-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6af0b02a76e714a8c8612a1115f8120e31b088554ac9b1531c13918059baaf6 |
|
MD5 | 57d369033a281f4019a3d19cc447a4cb |
|
BLAKE2b-256 | aed2ab3aad04bb5390495283adab51e89e4997c74c39cab6d12284a7d69f83de |