Skip to main content

Python class to talk to idms REST and Search API, better known as iDMS.

Project description

iDMS

Upload Python Package

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

  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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

idms-0.2.4.tar.gz (11.8 kB view hashes)

Uploaded Source

Built Distribution

idms-0.2.4-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page