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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: idms-0.2.7.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.7.tar.gz
Algorithm Hash digest
SHA256 1d449d2a44182d4f50611c44d03b090ee73c0d086d35da385f932b6ecb2c0ce9
MD5 291a2fd6c73070225d1875fa6a32b58f
BLAKE2b-256 dcc440d25b38030d755b144fb58828275538ea042d407dbb2b7ec724b0d6b55a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: idms-0.2.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 81d2c81d453e1818453811ef63646568eadaf9a4776f9fb71ef9c13339bb43c6
MD5 8d09ee23296d149a5db54cbeee4a84cf
BLAKE2b-256 77d594bf4a76490f6e614838783acc72ac28604f2df567188352198c9e8c2b97

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