Skip to main content

PyPPMS

Pytest-Poetry 🧪🎭 codecov

PUMAPI - Python Interface

Stratocore's PPMS booking system offers an API (the so-called PUMAPI, short for PPMS Utility Management API) for fetching information from the booking system as well as changing its state and properties.

This is a Python 3 package for talking to the PUMAPI.

Usage Example

Fetch email addresses of all active users:

from pyppmsconf import PYPPMS_URI, PYPPMS_API_KEY
from pyppms import ppms
from pyppms.common import set_loglevel

set_loglevel("TRACE")  # optional, default is "DEBUG"

conn = ppms.PpmsConnection(PYPPMS_URI, PYPPMS_API_KEY)

print("Querying PPMS for emails of active users, can take minutes...")
emails = ppms.get_users_emails(active=True)
print(f"Got {len(emails)} email addresses from PPMS:")
print("\n".join(emails))

Testing

Automated testing is described in the TESTING document on github.

Note

The PPMS API sometimes exposes a bit of a surprising behavior. During development of the package, we came across several issues (this list is certainly incomplete):

  • HTTP status return code is always 200, even on failed authentication.
  • Results of queries are a mixture of CSV (with headers) and and text with newlines (with no headers and therefore without structural information on the data). JSON is implemented in some cases only.
  • The CSV headers sometimes do contain spaces between the colons, sometimes they don't.
  • Some fields are quoted in the CSV output, some are not. Difficult to separate the values since there are colons in the values too.
  • Semantics of keys is not consistent. Sometimes user is the user id, sometimes it refers to the user's full name.
  • Using an invalid permission level (e.g. Z) with the setright action is silently ignored by PUMAPI, the response is still done even though this doesn't make any sense.
  • There is no (obvious) robust way to derive the user id from the user's full name that is returned e.g. by getrunningsheet, making it very hard to cross-reference it with data from getuser.
  • The result of the getrunningsheet query in general is not suited very well for automated processing, it seems to be rather tailored for humans and subject to (mis-) interpretation.
  • Unfortunately Username and Systemname are not the unique id, they are rather the full description. Therefore sometimes looping over all users and systems is necessary.
  • Some results have a very strange format - for example, the starting time of the next booking is given as minutes from now instead of an absolute time.
  • Official documentation is rather rudimentary, i.e. it contains almost no information on what is returned in case wrong / invalid parameters are supplied and similar situations.

References

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyppms-4.0.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyppms-4.0.0-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file pyppms-4.0.0.tar.gz.

File metadata

  • Download URL: pyppms-4.0.0.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyppms-4.0.0.tar.gz
Algorithm Hash digest
SHA256 f71583e68cd6819454226c180d77a63cef4f908fb88db1fe76e79a761ed01466
MD5 1c01fcd8c4a71b2378b75e1b9f03e12f
BLAKE2b-256 eaade2afc1dae682c437ec5abcf09a29c9a5ec9996fe7219b34ffcfbe47782f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyppms-4.0.0.tar.gz:

Publisher: release.yml on imcf/pyppms

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyppms-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: pyppms-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyppms-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce85a96e79cb3723dafee9f6d72ca328c347c47f8f84937c51bb88063b17783b
MD5 3b30e6020eb21560435736681f2a7734
BLAKE2b-256 a9c73b313db607fdb4967edcece039a8278a3e76730d44712817f9c387b438b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyppms-4.0.0-py3-none-any.whl:

Publisher: release.yml on imcf/pyppms

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page