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 20.2, 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.1.9.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

idms-0.1.9-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: idms-0.1.9.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for idms-0.1.9.tar.gz
Algorithm Hash digest
SHA256 10c7d08f1f4bd32e323747011d7af6329866b587d4831fac98bfe4a7ef70dcec
MD5 435396653142e55af6f70c026762a0bc
BLAKE2b-256 7d9cb24fb76a698bc7d2690d65bab162abbb6bd61f67aa44c600512a5f629d78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: idms-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for idms-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f889fdf33c5595e98ce240f6bac20a8d3675b44ab0b247afac6bce6e035f9cf0
MD5 20583dd56b0bc93dcd962f33b24cef76
BLAKE2b-256 f72e579d647ccb6cc97351edecf5b9cd4dc23fbbd1fad9a1dddd9a332495a7f3

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