pyxecm 3.6.2__tar.gz → 3.8.0__tar.gz

{pyxecm-3.6.2 → pyxecm-3.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyxecm
-Version: 3.6.2
+Version: 3.8.0
 Summary: A Python library to interact with Opentext Content Management Rest API
 Project-URL: Homepage, https://github.com/opentext/pyxecm
 Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>
@@ -11,7 +11,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Requires-Dist: lxml>=6.0.0
 Requires-Dist: opentelemetry-api>=1.34.1
 Requires-Dist: opentelemetry-exporter-otlp>=1.34.1
@@ -40,10 +40,12 @@ Provides-Extra: customizer
 Requires-Dist: kubernetes>=33.1.0; extra == 'customizer'
 Requires-Dist: openpyxl>=3.1.5; extra == 'customizer'
 Requires-Dist: playwright>=1.53.0; extra == 'customizer'
-Requires-Dist: pydantic>=2.11.7; extra == 'customizer'
+Requires-Dist: pydantic>=2.12.0; extra == 'customizer'
 Requires-Dist: python-hcl2==7.3.1; extra == 'customizer'
 Provides-Extra: magic
 Requires-Dist: python-magic; extra == 'magic'
+Provides-Extra: saml
+Requires-Dist: signxml>=5.1.0; extra == 'saml'
 Provides-Extra: sap
 Requires-Dist: pyrfc==3.3.1; extra == 'sap'
 Description-Content-Type: text/markdown

{pyxecm-3.6.2 → pyxecm-3.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyxecm"
-version = "3.6.2"
+version = "3.8.0"
 description = 'A Python library to interact with Opentext Content Management Rest API'
 keywords = [
   'opentext',
@@ -15,7 +15,7 @@ authors = [
   { name = "Kai Gatzweiler", email = "kgatzweiler@opentext.com" },
   { name = "Dr. Marc Diefenbruch", email = "mdiefenb@opentext.com" },
 ]
-requires-python = '>=3.10'
+requires-python = '>=3.12'
 dependencies = [
   "lxml>=6.0.0",
   "opentelemetry-api>=1.34.1",
@@ -43,10 +43,11 @@ classifiers = [
 [project.optional-dependencies]
 magic = ['python-magic']
 sap = ['pyrfc==3.3.1']
+saml = ['signxml>=5.1.0']
 customizer = [
   "kubernetes>=33.1.0",
   "playwright>=1.53.0",
-  "pydantic>=2.11.7",
+  "pydantic>=2.12.0",
   "python-hcl2==7.3.1",
   "openpyxl>=3.1.5",
 ]

{pyxecm-3.6.2 → pyxecm-3.8.0}/src/pyxecm/__init__.py

@@ -1,4 +1,4 @@
-"""pyxecm - A python library to interact with Opentext REST APIs."""
+"""pyxecm - A python library to interact with OpenText REST APIs."""
 
 __author__ = "Dr. Marc Diefenbruch"
 __copyright__ = "Copyright (C) 2024-2025, OpenText"

{pyxecm-3.6.2 → pyxecm-3.8.0}/src/pyxecm/avts.py

@@ -1,4 +1,4 @@
-"""AVTS stands for Aviator Search and is an OpenText offering for LLMM-based search across multiple repositories."""
+"""AVTS stands for Aviator Search and is an OpenText offering for LLM-based search across multiple repositories."""
 
 __author__ = "Dr. Marc Diefenbruch"
 __copyright__ = "Copyright (C) 2024-2025, OpenText"
@@ -172,7 +172,7 @@ class AVTS:
                 HTTP method (GET, POST, etc.). Defaults to "GET".
             headers (dict | None, optional):
                 Request headers. Defaults to None.
-            data (dict | None, optional):
+            data (dict | list | None, optional):
                 Request payload. Defaults to None.
             json_data (dict | None, optional):
                 Request payload for the JSON parameter. Defaults to None.
@@ -315,7 +315,7 @@ class AVTS:
 
         Args:
             response_object (requests.Response):
-                This is reponse object delivered by the request call.
+                This is the response object delivered by the request call.
             additional_error_message (str, optional):
                 Use a more specific error message in case of an error.
             show_error (bool, optional):
@@ -650,13 +650,13 @@ class AVTS:
             certificate_password (str):
                 The password for the certificate.
             index_attachments (bool, optional):
-                Whether or not to index / crawl attachments.
+                Whether or not to index / crawl attachments. Defaults to True.
             index_call_recordings (bool, optional):
-                Whether or not to index / crawl meeting recordings.
+                Whether or not to index / crawl meeting recordings. Defaults to True.
             index_message_replies (bool, optional):
-                Whether or not to index / crawl message replies.
+                Whether or not to index / crawl message replies. Defaults to True.
             index_user_chats (bool, optional):
-                Whether or not to index / crawl user chats.
+                Whether or not to index / crawl user chats. Defaults to True.
 
         Returns:
             dict | None:
@@ -956,9 +956,9 @@ class AVTS:
             tenant_id (str):
                 The M365 tenant ID.
             certificate_file (str):
-                TODO: _description_
+                The path to the certificate file.
             certificate_password (int):
-                TODO: _description_
+                The password for the certificate.
             sharepoint_url (str):
                 The SharePoint URL.
             sharepoint_url_type (str):
@@ -968,11 +968,11 @@ class AVTS:
             sharepoint_admin_url (str):
                 The SharePoint administration URL.
             index_user_profiles (bool, optional):
-                TODO: _description_. Defaults to True.
+                Whether or not to index information from user profiles. Defaults to True.
             oauth2_site_name (str, optional):
-                TODO: _description_. Defaults to "AVTS".
+                The value of the "OAuth2SiteName" repository parameter. Defaults to "AVTS".
             oauth2_sites_file (str, optional):
-                TODO: _description_. Defaults to "".
+                The value of the "OAuth2SitesFile" repository parameter. Defaults to "".
 
         Returns:
             dict | None:
@@ -1440,7 +1440,7 @@ class AVTS:
 
         Returns:
             dict | None:
-                ID of a repostiory by name or None in case of an error
+                The repository data for the given name or None if no repository is found or in case of an error
 
         """
 
@@ -1459,7 +1459,7 @@ class AVTS:
     def get_certificate_file_content_base64(self, filepath: str) -> str | None:
         """Return the certificate as a base64 string.
 
-        In Kubernetes deploymnets the certificate is already mounted base64 encoded.
+        In Kubernetes deployments the certificate is already mounted base64 encoded.
 
         Args:
             filepath (str):
@@ -1512,7 +1512,7 @@ class AVTS:
     # end method definition
 
     def set_questions(self, questions: list) -> list | None:
-        """Get a list of all repositories.
+        """Set the list of proposed questions.
 
         Args:
             questions (list):
@@ -1520,7 +1520,7 @@ class AVTS:
 
         Returns:
             list | None:
-                Parsed response object from the API listing all repositories or None in case of an error.
+                Parsed response object from the API or None in case of an error.
 
         """
 

{pyxecm-3.6.2 → pyxecm-3.8.0}/src/pyxecm/coreshare.py

@@ -253,7 +253,7 @@ class CoreShare:
                   Data is sent as key-value pairs in the body of the request, similar to query parameters.
                 * multipart/form-data - Used for file uploads or when a form includes non-ASCII characters
 
-        Return:
+        Returns:
             dict:
                 The request header values.
 
@@ -279,7 +279,7 @@ class CoreShare:
             content_type (str, optional):
                 The content type for the request.
 
-        Return:
+        Returns:
             dict:
                 The request header values.
 
@@ -316,7 +316,7 @@ class CoreShare:
         user_credentials: bool = False,
         verify: bool = True,
     ) -> dict | None:
-        """Call an OTDS REST API in a safe way.
+        """Call a Core Share REST API in a safe way.
 
         Args:
             url (str):
@@ -338,9 +338,8 @@ class CoreShare:
                 Whether or not an error should be logged in case of a failed REST call.
                 If False, then only a warning is logged. Defaults to True.
             show_warning (bool, optional):
-                Whether or not an warning should be logged in case of a
-                failed REST call.
-                If False, then only a warning is logged. Defaults to True.
+                Whether or not a warning should be logged in case of a
+                failed REST call (only used if show_error is False). Defaults to False.
             warning_message (str, optional):
                 Specific warning message. Defaults to "". If not given the error_message will be used.
             failure_message (str, optional):
@@ -363,7 +362,7 @@ class CoreShare:
 
         Returns:
             dict | None:
-                Response of OTDS REST API or None in case of an error.
+                Response of the Core Share REST API or None in case of an error.
 
         """
 
@@ -519,7 +518,7 @@ class CoreShare:
 
         Args:
             response_object (object):
-                This is reponse object returned by the request call.
+                This is the response object returned by the request call.
             additional_error_message (str, optional):
                 Can be used to provide a more specific error message
                 in case an error occurs.
@@ -564,11 +563,11 @@ class CoreShare:
         value: str,
         return_key: str,
     ) -> str | None:
-        """Lookup a property value based on a provided key / value pair in the response of an Core Share REST API call.
+        """Lookup a property value based on a provided key / value pair in the response of a Core Share REST API call.
 
         Args:
             response (dict):
-                REST response from an Core Share REST Call
+                REST response from a Core Share REST Call
             key (str):
                 The property name (key).
             value (str):
@@ -617,7 +616,7 @@ class CoreShare:
             value (str):
                 The value to find in the item with the matching key.
             results_marker (str, optional):
-                The name of the data structure for the results.
+                The name of the data structure for the results. Defaults to "results".
 
         Returns:
             bool:
@@ -710,12 +709,12 @@ class CoreShare:
 
         Args:
             revalidate (bool, optional):
-                Defines whether or not a re-athentication is enforced
+                Defines whether or not a re-authentication is enforced
                 (e.g. if session has timed out with 401 error).
 
         Returns:
             str:
-                The access token. Also stores access token in self._access_token.
+                The access token. Also stores access token in self._access_token_admin.
                 None in case of error.
 
         """
@@ -796,14 +795,14 @@ class CoreShare:
 
         Args:
             revalidate (bool, optional):
-                Defines whether or not a re-athentication is enforced
+                Defines whether or not a re-authentication is enforced
                 (e.g. if session has timed out with 401 error).
             grant_type (str, optional):
-                Can either be "client_credentials" (default) or "password".
+                Can either be "client_credentials" or "password". Defaults to "password".
 
         Returns:
             str:
-                The access token. Also stores access token in self._access_token.
+                The access token. Also stores access token in self._access_token_user.
                 None in case of error.
 
         """
@@ -944,8 +943,8 @@ class CoreShare:
         Returning a generator avoids loading a large number of items into memory at once. Instead you
         can iterate over the potential large list of Core Share groups.
 
-        Example usage:
-            groups = core_share_object.get_groups_iterator(page_size=10)
+        Example:
+            groups = core_share_object.get_groups_iterator(count=10)
             for group in groups:
                 logger.info("Traversing Core Share group -> %s", group["name"])
 
@@ -956,7 +955,7 @@ class CoreShare:
 
         Returns:
             iter:
-                A generator yielding one OTDS group per iteration.
+                A generator yielding one Core Share group per iteration.
                 If the REST API fails, returns no value.
 
         """
@@ -1005,7 +1004,7 @@ class CoreShare:
         group_name: str,
         description: str = "",
     ) -> dict | None:
-        """Add a new Core Share group. This requires a Tenent Admin authorization.
+        """Add a new Core Share group. This requires a Tenant Admin authorization.
 
         Args:
             group_name (str):
@@ -1149,7 +1148,7 @@ class CoreShare:
 
         Returns:
             list | None:
-                Dictionary with the Core Share group membership or None if the request fails.
+                List with the Core Share group membership or None if the request fails.
 
             Example Response ('errors' is only output if success = False):
             [
@@ -1240,7 +1239,7 @@ class CoreShare:
 
         Returns:
             list | None:
-                Dictionary with the Core Share group membership or None if the request fails.
+                List with the Core Share group membership or None if the request fails.
 
             Example Response ('errors' is only output if success = False):
             [
@@ -1378,10 +1377,12 @@ class CoreShare:
         """Search Core Share group(s) using a query string.
 
         Args:
-            query_string(str): Query for the group name / property
+            query_string (str):
+                Query for the group name / property.
 
         Returns:
-            dict | None: Dictionary with the Core Share user data or None if the request fails.
+            dict | None:
+                Dictionary with the Core Share group data or None if the request fails.
 
         """
 
@@ -1413,9 +1414,6 @@ class CoreShare:
     def get_users(self) -> list | None:
         """Get Core Share users.
 
-        Args:
-            None
-
         Returns:
             list | None:
                 List with the Core Share user data or None if the request fails.
@@ -1664,7 +1662,7 @@ class CoreShare:
 
         """
 
-        # Search the users with this first and last name (and hope this is unique ;-).
+        # Search the users with this email address (and hope this is unique ;-).
         users = self.search_users(
             query_string=email,
             user_status=user_status,
@@ -1776,7 +1774,7 @@ class CoreShare:
         title: str | None = None,
         company: str | None = None,
     ) -> dict | None:
-        """Add a new Core Share user. This requires a Tenent Admin authorization.
+        """Add a new Core Share user. This requires a Tenant Admin authorization.
 
         Args:
             first_name (str):
@@ -2094,7 +2092,7 @@ class CoreShare:
 
         response = None
 
-        # Admins don't have/need specific access roles. They are controled by isAdmin flag.
+        # Admins don't have/need specific access roles. They are controlled by isAdmin flag.
         if is_admin is not None:
             update_data = {}
             update_data["isAdmin"] = is_admin
@@ -2514,7 +2512,7 @@ class CoreShare:
 
         Returns:
             dict | None:
-                Reponse of the REST call or None in case of an error.
+                Response of the REST call or None in case of an error.
 
         """
 
@@ -2604,7 +2602,7 @@ class CoreShare:
            * Local resources - not shared
            * Resources shared by the user
            * Resources shared by other users or groups
-           This method impersonate as the user. Only the user can delete its folders.
+           This method impersonates the user. Only the user can delete its folders.
            The Core Share admin is not entitled to do this.
 
         Args:
@@ -2634,7 +2632,7 @@ class CoreShare:
             )
             return True
 
-        self.logger.info("Inpersonate as user -> %s to cleanup files...", user_login)
+        self.logger.info("Impersonate as user -> %s to cleanup files...", user_login)
 
         # Save admin credentials the class has been initialized with:
         admin_credentials = self.credentials()
@@ -2713,7 +2711,7 @@ class CoreShare:
                         response = self.delete_document(item["id"])
                     else:
                         self.logger.error(
-                            "Unsupport resource type -> '%s'! Cannot remove this item from Core Share.",
+                            "Unsupported resource type -> '%s'! Cannot remove this item from Core Share.",
                             item["resourceType"],
                         )
                         response = None
@@ -2795,7 +2793,7 @@ class CoreShare:
             group_id (str):
                 The Core Share group ID.
             resource_id (str):
-                The ID of the Core share folder.
+                The ID of the Core Share folder.
 
         Returns:
             dict | None:

{pyxecm-3.6.2 → pyxecm-3.8.0}/src/pyxecm/helper/assoc.py

@@ -22,10 +22,12 @@ class Assoc:
         """Determine if a string is unicode escaped.
 
         Args:
-            assoc_string (str): string with the Assoc data
+            assoc_string (str):
+                String with the Assoc data.
 
         Returns:
-            bool: True if string is in Unicode, False otherwise
+            bool:
+                True if the string contains unicode escape sequences, False otherwise.
 
         """
 
@@ -100,13 +102,15 @@ class Assoc:
 
     @classmethod
     def unescape_html(cls, assoc_string: str) -> str:
-        """HTML unescape a a string.
+        """HTML unescape a string.
 
         Args:
-            assoc_string (str): the string to unescape.
+            assoc_string (str):
+                The string to unescape.
 
         Returns:
-            str: unescaped string
+            str:
+                The unescaped string.
 
         """
 
@@ -218,13 +222,13 @@ class Assoc:
             input_string (str):
                 Input string to search the delimited substring in.
             start_sequence (str):
-                Start esequence of characters.
+                Start sequence of characters.
             stop_sequence (str):
-                Stop sequence of characters
+                Stop sequence of characters.
 
         Returns:
             str | None:
-                The deliminated substring or None if not found.
+                The delimited substring (including start and stop sequence) or None if not found.
 
         """
 
@@ -245,14 +249,14 @@ class Assoc:
     def extract_assoc_string(cls, input_string: str, is_escaped: bool = False) -> str:
         """Extract an Assoc from a string.
 
-        The assoc is deliminated by A< ... >.
+        The assoc is delimited by A< ... >.
 
         Args:
             input_string (str):
                 Input string that includes the Assoc as a substring.
             is_escaped (bool, optional):
                 Whether or not the input string includes the
-                assoc escaped or not.
+                assoc escaped or not. Defaults to False.
 
         Returns:
             str: