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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: idms-0.2.4.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for idms-0.2.4.tar.gz
Algorithm Hash digest
SHA256 d724ee832dd4d214508b4050d03f8562ac0b94c1d2a60a018c4695e290d282e4
MD5 64eadbf0e56d406480b3be4019f7589b
BLAKE2b-256 8e42f4adf3c3297b93b2633075412eef7a5e223f784902a8b59e00d9733e72f4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: idms-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for idms-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e606ab8b978db07fd009673605ded097a77983b09bc37c2232b600adced52fb0
MD5 73d08f034e8b9166746af7b562ebc25f
BLAKE2b-256 2106856bf05948815eb809c0846af68d44f06a8a2d14c17284cc88626143a5a6

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