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

Uploaded Source

Built Distribution

idms-0.2.1-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for idms-0.2.1.tar.gz
Algorithm Hash digest
SHA256 a8af9d2425a4d27342197882da5259496c1bc207fbcdebc60244cefdc8119fc8
MD5 2474677dc6c70f6d0a082eb12ef80763
BLAKE2b-256 c32bef69cfd1ef3348d46e2b5f9ccf2b26c1b43e4c7d79e073d28d2612dedb67

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for idms-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d4fa93093990e7c3937959ccc274cfdd274c4c4a251b1f42915bbe1ba6a9eef7
MD5 2aff35ba9acb1add4c06755080ddcf06
BLAKE2b-256 c72406a762d800f10202d9c05a4716b30eba975520cb251da29f1c0a689d7580

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