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.6.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

idms-0.2.6-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file idms-0.2.6.tar.gz.

File metadata

  • Download URL: idms-0.2.6.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for idms-0.2.6.tar.gz
Algorithm Hash digest
SHA256 b217d23732e0ab5d6408ff02415e50cb6cced3cdbc5d6d317afb52f3852a88ea
MD5 d079b0b9d574a73008a32f00bb179cd6
BLAKE2b-256 45a81b09dbc5cc4d1a71aa2f9610a6e71ba9bfaf374ea3fe62efda8f89df63ed

See more details on using hashes here.

File details

Details for the file idms-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: idms-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for idms-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ddd13eeee8a16e7f5a920af44f8d0269f10259552c4762f217028d1e83bbd7c8
MD5 e1a21ef6b95aa69fe8da686c5e5645fa
BLAKE2b-256 171edf32c75f1876aa997e64bed9fb49fa07336e4628706686a5ca2869ffde4c

See more details on using hashes here.

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