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

Uploaded Source

Built Distribution

idms-0.2.3-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: idms-0.2.3.tar.gz
  • Upload date:
  • Size: 11.6 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.3.tar.gz
Algorithm Hash digest
SHA256 9e2af1a61bfe72897647f989f5afec0818072033bdc3908beb47f74d50418b90
MD5 d06f8f4a8d8b04e06d35768f153ee241
BLAKE2b-256 758cd7989695f557d412057317ac90c02db4493d7c498d103f6d620c14c6b870

See more details on using hashes here.

File details

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

File metadata

  • Download URL: idms-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 8.8 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a128d91ba29dcc9a1128cb08d5d628809226fed6688dcee2d0f0533446bef36f
MD5 4b6f3c069523e99c2881f1faa70b8535
BLAKE2b-256 efcac97071114f81188808be7d611242c654967abb0c3b321153f2234bd34cbe

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