pyxecm 3.0.1__py3-none-any.whl → 3.1.1__py3-none-any.whl

pyxecm/otkd.py

@@ -50,8 +50,8 @@ REQUEST_UPLOAD_HEADERS = {
     # DO NOT set "Content-Type" manually
 }
 
-REQUEST_TIMEOUT = 60
-REQUEST_RETRY_DELAY = 20
+REQUEST_TIMEOUT = 60.0
+REQUEST_RETRY_DELAY = 20.0
 REQUEST_MAX_RETRIES = 2
 
 default_logger = logging.getLogger(MODULE_NAME)
@@ -301,7 +301,7 @@ class OTKD:
         data: dict | None = None,
         json_data: dict | None = None,
         files: dict | None = None,
-        timeout: int | None = REQUEST_TIMEOUT,
+        timeout: float | None = REQUEST_TIMEOUT,
         show_error: bool = True,
         show_warning: bool = False,
         warning_message: str = "",
@@ -327,7 +327,7 @@ class OTKD:
             files (dict | None, optional):
                 Dictionary of {"name": file-tuple} for multipart encoding upload.
                 File-tuple can be a 2-tuple ("filename", fileobj) or a 3-tuple ("filename", fileobj, "content_type")
-            timeout (int | None, optional):
+            timeout (float | None, optional):
                 The timeout for the request in seconds. Defaults to REQUEST_TIMEOUT.
             show_error (bool, optional):
                 Whether or not an error should be logged in case of a failed REST call.

pyxecm/otmm.py

@@ -47,7 +47,7 @@ REQUEST_HEADERS = {
     "User-Agent": USER_AGENT,
     "Content-Type": "application/x-www-form-urlencoded",
 }
-REQUEST_TIMEOUT = 60
+REQUEST_TIMEOUT = 60.0
 
 default_logger = logging.getLogger(MODULE_NAME)
 

pyxecm/otpd.py

@@ -9,11 +9,46 @@ __email__ = "mdiefenb@opentext.com"
 import json
 import logging
 import os
+import platform
+import sys
+import time
+from http import HTTPStatus
+from importlib.metadata import version
 
 import requests
 from requests.auth import HTTPBasicAuth
 from requests_toolbelt.multipart.encoder import MultipartEncoder
 
+APP_NAME = "pyxecm"
+APP_VERSION = version("pyxecm")
+MODULE_NAME = APP_NAME + ".otpd"
+
+PYTHON_VERSION = f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
+OS_INFO = f"{platform.system()} {platform.release()}"
+ARCH_INFO = platform.machine()
+REQUESTS_VERSION = requests.__version__
+
+USER_AGENT = (
+    f"{APP_NAME}/{APP_VERSION} ({MODULE_NAME}/{APP_VERSION}; "
+    f"Python/{PYTHON_VERSION}; {OS_INFO}; {ARCH_INFO}; Requests/{REQUESTS_VERSION})"
+)
+
+REQUEST_HEADERS = {
+    "User-Agent": USER_AGENT,
+    "accept": "application/json;charset=utf-8",
+    "Content-Type": "application/json",
+}
+
+REQUEST_FORM_HEADERS = {
+    "User-Agent": USER_AGENT,
+    "accept": "application/json;charset=utf-8",
+    "Content-Type": "application/x-www-form-urlencoded",
+}
+
+REQUEST_TIMEOUT = 60.0
+REQUEST_RETRY_DELAY = 20.0
+REQUEST_MAX_RETRIES = 2
+
 default_logger = logging.getLogger("pyxecm.otpd")
 
 request_headers = {
@@ -93,15 +128,17 @@ class OTPD:
         otpd_base_url = protocol + "://" + otpd_config["hostname"]
         if str(port) not in ["80", "443"]:
             otpd_base_url += ":{}".format(port)
-        otpd_base_url += "/ServerManager"
         otpd_config["baseUrl"] = otpd_base_url
 
-        otpd_rest_url = otpd_base_url + "/api"
+        otpd_servermanager_url = otpd_base_url + "/ServerManager"
+        otpd_config["serverManagerUrl"] = otpd_servermanager_url
+
+        otpd_rest_url = otpd_servermanager_url + "/api"
         otpd_config["restUrl"] = otpd_rest_url
 
         otpd_config["settingsUrl"] = otpd_rest_url + "/v1/settings"
 
-        otpd_config["importDatabaseUrl"] = otpd_base_url + "/servlet/import"
+        otpd_config["importDatabaseUrl"] = otpd_servermanager_url + "/servlet/import"
 
         self._config = otpd_config
 
@@ -174,32 +211,6 @@ class OTPD:
 
     # end method definition
 
-    def base_url(self) -> str:
-        """Return the base URL of PowerDocs.
-
-        Returns:
-            string:
-                The base URL.
-
-        """
-
-        return self.config()["baseUrl"]
-
-    # end method definition
-
-    def rest_url(self) -> str:
-        """Return the REST URL of PowerDocs.
-
-        Returns:
-            string:
-                The REST URL.
-
-        """
-
-        return self.config()["restUrl"]
-
-    # end method definition
-
     def parse_request_response(
         self,
         response_object: object,
@@ -270,7 +281,7 @@ class OTPD:
             return self._jsessionid
 
         auth_url = (
-            self.base_url()
+            self.config()["serverManagerUrl"]
             + "/j_security_check?j_username="
             + self.config()["username"]
             + "&j_password="
@@ -482,3 +493,208 @@ class OTPD:
                 return None
 
     # end method definition
+
+    def do_request(
+        self,
+        url: str,
+        method: str = "GET",
+        headers: dict | None = None,
+        data: dict | None = None,
+        json_data: dict | None = None,
+        files: dict | None = None,
+        timeout: float | None = REQUEST_TIMEOUT,
+        show_error: bool = True,
+        show_warning: bool = False,
+        warning_message: str = "",
+        failure_message: str = "",
+        success_message: str = "",
+        max_retries: int = REQUEST_MAX_RETRIES,
+        retry_forever: bool = False,
+        parse_request_response: bool = True,
+    ) -> dict | None:
+        """Call an OTDS REST API in a safe way.
+
+        Args:
+            url (str):
+                The URL to send the request to.
+            method (str, optional):
+                The HTTP method (GET, POST, etc.). Defaults to "GET".
+            headers (dict | None, optional):
+                The request headers. Defaults to None.
+            data (dict | None, optional):
+                Request payload. Defaults to None
+            json_data (dict | None, optional):
+                Request payload for the JSON parameter. Defaults to None.
+            files (dict | None, optional):
+                Dictionary of {"name": file-tuple} for multipart encoding upload.
+                File-tuple can be a 2-tuple ("filename", fileobj) or a 3-tuple ("filename", fileobj, "content_type")
+            timeout (int | None, optional):
+                The timeout for the request in seconds. Defaults to REQUEST_TIMEOUT.
+            show_error (bool, optional):
+                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.
+            warning_message (str, optional):
+                Specific warning message. Defaults to "". If not given the error_message will be used.
+            failure_message (str, optional):
+                Specific error message. Defaults to "".
+            success_message (str, optional):
+                Specific success message. Defaults to "".
+            max_retries (int, optional):
+                How many retries on Connection errors? Default is REQUEST_MAX_RETRIES.
+            retry_forever (bool, optional):
+                Eventually wait forever - without timeout. Defaults to False.
+            parse_request_response (bool, optional):
+                Defines if the response.text should be interpreted as json and loaded into a dictionary.
+                True is the default.
+
+        Returns:
+            dict | None:
+                Response of OTDS REST API or None in case of an error.
+
+        """
+
+        if headers is None:
+            headers = REQUEST_HEADERS
+
+        # In case of an expired session we reauthenticate and
+        # try 1 more time. Session expiration should not happen
+        # twice in a row:
+        retries = 0
+
+        while True:
+            try:
+                response = requests.request(
+                    method=method,
+                    url=url,
+                    data=data,
+                    json=json_data,
+                    files=files,
+                    headers=headers,
+                    timeout=timeout,
+                )
+
+                if response.ok:
+                    if success_message:
+                        self.logger.info(success_message)
+                    if parse_request_response:
+                        return self.parse_request_response(response)
+                    else:
+                        return response
+                else:
+                    # Handle plain HTML responses to not pollute the logs
+                    content_type = response.headers.get("content-type", None)
+                    response_text = (
+                        "HTML content (only printed in debug log)" if content_type == "text/html" else response.text
+                    )
+
+                    if show_error:
+                        self.logger.error(
+                            "%s; status -> %s/%s; error -> %s",
+                            failure_message,
+                            response.status_code,
+                            HTTPStatus(response.status_code).phrase,
+                            response_text,
+                        )
+                    elif show_warning:
+                        self.logger.warning(
+                            "%s; status -> %s/%s; warning -> %s",
+                            warning_message if warning_message else failure_message,
+                            response.status_code,
+                            HTTPStatus(response.status_code).phrase,
+                            response_text,
+                        )
+                    if content_type == "text/html":
+                        self.logger.debug(
+                            "%s; status -> %s/%s; warning -> %s",
+                            failure_message,
+                            response.status_code,
+                            HTTPStatus(response.status_code).phrase,
+                            response.text,
+                        )
+                    return None
+            except requests.exceptions.Timeout:
+                if retries <= max_retries:
+                    self.logger.warning(
+                        "Request timed out. Retrying in %s seconds...",
+                        str(REQUEST_RETRY_DELAY),
+                    )
+                    retries += 1
+                    time.sleep(REQUEST_RETRY_DELAY)  # Add a delay before retrying
+                else:
+                    self.logger.error(
+                        "%s; timeout error.",
+                        failure_message,
+                    )
+                    if retry_forever:
+                        # If it fails after REQUEST_MAX_RETRIES retries we let it wait forever
+                        self.logger.warning("Turn timeouts off and wait forever...")
+                        timeout = None
+                    else:
+                        return None
+            except requests.exceptions.ConnectionError:
+                if retries <= max_retries:
+                    self.logger.warning(
+                        "Connection error. Retrying in %s seconds...",
+                        str(REQUEST_RETRY_DELAY),
+                    )
+                    retries += 1
+                    time.sleep(REQUEST_RETRY_DELAY)  # Add a delay before retrying
+                else:
+                    self.logger.error(
+                        "%s; connection error.",
+                        failure_message,
+                    )
+                    if retry_forever:
+                        # If it fails after REQUEST_MAX_RETRIES retries we let it wait forever
+                        self.logger.warning("Turn timeouts off and wait forever...")
+                        timeout = None
+                        time.sleep(REQUEST_RETRY_DELAY)  # Add a delay before retrying
+                    else:
+                        return None
+            # end try
+            self.logger.info(
+                "Retrying REST API %s call -> %s... (retry = %s",
+                method,
+                url,
+                str(retries),
+            )
+        # end while True
+
+    # end method definition
+
+    def generate_document(self, payload: str) -> dict | None:
+        """Generate a PowerDocs document based on the provided XML payload.
+
+        Args:
+            payload (str):
+                The XML payload to generate the document.
+
+        Returns:
+            dict | None:
+                The request response or None in case of an error.
+
+        """
+
+        if not payload:
+            self.logger.error("Cannot generate PowerDocs document from empty payload!")
+            return None
+
+        url = self.config()["baseUrl"] + "/c4ApplicationServer/rest/document"
+
+        body = {"documentgeneration": payload}
+
+        response = self.do_request(
+            url=url,
+            method="POST",
+            headers=REQUEST_FORM_HEADERS,
+            data=body,
+            show_error=True,
+            failure_message="Failed to generate PowerDocs document",
+            parse_request_response=False,
+        )
+
+        return response

{pyxecm-3.0.1.dist-info → pyxecm-3.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyxecm
-Version: 3.0.1
+Version: 3.1.1
 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>
@@ -37,6 +37,7 @@ Requires-Dist: python-multipart>=0.0.20; extra == 'api'
 Requires-Dist: uvicorn>=0.35.0; extra == 'api'
 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: python-hcl2>=7.2.1; extra == 'customizer'

pyxecm-3.1.1.dist-info/RECORD

@@ -0,0 +1,82 @@
+pyxecm/__init__.py,sha256=KNvTFbDVHylf8Ub28osm5Dw0W-ck-94y27lIBuE32RE,441
+pyxecm/avts.py,sha256=NEd1JdJCVmNohp_A-ZxAIMQZX5NCJFMhyKV6cdLFgTw,56960
+pyxecm/coreshare.py,sha256=oz5SASlOC_e4-OIazFUrIA7gB6DfpC7RY4Ck7AHKcvQ,95999
+pyxecm/otac.py,sha256=itsxIkIhIHdAiRCLRegmxCejE3kqpWxgwaJvAGNqzzg,22849
+pyxecm/otawp.py,sha256=9kQghTIrnHP5I_GOmnAlvPhJk433b0dcdVzQHx0fSAM,112962
+pyxecm/otca.py,sha256=_HJG84yFr00CvdgMlvTnmAYNs-6w1APbzUzZb5udkuk,99597
+pyxecm/otcs.py,sha256=5YPdvkl8CBDMRNjVOkUDRce-GnBxaVGF98mAGakrvSM,819480
+pyxecm/otds.py,sha256=gTyHwCSFVJbEia3h-xcPY0UL1fS58VxuI0l9uA3lC6c,191581
+pyxecm/otiv.py,sha256=I5lt4sz7TN3W7BCstCKQY2WQnei-t0tXdM4QjRQRmWI,2358
+pyxecm/otkd.py,sha256=3c37FwQ-KDBN48O1wZVxX46BiQDRtb2-KrXZ7HG54Fg,47488
+pyxecm/otmm.py,sha256=MC4roK8SNG3RPj7Nb-iwn8siH9CLLmhwTmw-84i6zm4,80733
+pyxecm/otpd.py,sha256=MXtgaRMEgVXBbc6hPm9tXq--NpzYAkSMnaL_p2H4b7E,23875
+pyxecm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyxecm/helper/__init__.py,sha256=B35HdIZC9wZ1m_sx4NOPggyFFJoXmFuA1T2tuPDU1W8,246
+pyxecm/helper/assoc.py,sha256=yOh4GFZEkTfIaVVrHBr4bhMtIv-E76oDVWGqaUdVqyA,7321
+pyxecm/helper/data.py,sha256=L92y9dagzJLwdfZW-ISUemkJEuGFo8kGz3r18c01GPc,123363
+pyxecm/helper/logadapter.py,sha256=ExrIKpA2JKegkTIky0wDDTgPYSvVmwQLrDh5jko_6hQ,724
+pyxecm/helper/otel_config.py,sha256=nMzNi3Jv2_kmYG4thzDpN95bqjy6MbRfV6nlpIZ6SjQ,907
+pyxecm/helper/web.py,sha256=YqR72jWSeg3dOEdhN6b09s-kSnHbTjDIl56QC5NvNtE,13386
+pyxecm/helper/xml.py,sha256=6FJ-ApiJmBBo6IwtnWj93DVB016ZTSlQIMXQNvFumOI,47091
+pyxecm_api/__init__.py,sha256=8oXxEEFSu2afpyQURpxMA2qTZAB3MUdbBrndogDn5Oc,92
+pyxecm_api/__main__.py,sha256=Q2tcaoSExPMUwGVBrE4AHT8DNvB4XIgwoN4EPDx5Rt8,117
+pyxecm_api/app.py,sha256=OkBipbCPeDM8KO-LvehYKdSyXcXvVHSwz4vXx8CZdZY,7256
+pyxecm_api/settings.py,sha256=Zu4LnBsCUm9bi7riE_uP2JynWkSmUjJtGrLmSZQXpRg,5535
+pyxecm_api/auth/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/auth/functions.py,sha256=hdu4XPS975r8LsbH_3OKNQOEMvnbD40zhRh1nO1hIyQ,3331
+pyxecm_api/auth/models.py,sha256=lKebaIHbALZ10quCCKQ3wf7w8V6k84tFXcPV1zbQsS0,271
+pyxecm_api/auth/router.py,sha256=H58owZMM9lcskUITWSJPZYQr6IM66MyV7h9G36HPpQM,2140
+pyxecm_api/common/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/common/functions.py,sha256=snu6bFNvky4JUCRbWdeE64wUjIH2NWVihXbf9nfTpsQ,5209
+pyxecm_api/common/metrics.py,sha256=kOJ1DZveZJ7xFd1pB12Zbkq6Z-evaTivpgO_ujVbsxM,2707
+pyxecm_api/common/models.py,sha256=c76ysWUt40A875DirsFMXttxwjHvBYvjuOVEXePSZ9k,456
+pyxecm_api/common/router.py,sha256=BXi3SMvkswCIftoVkJIP_Wx8gd3WKJsE3rq6Pult50I,3482
+pyxecm_api/terminal/__init__.py,sha256=RHlTzdGeOY0_dvvNZS_wq6uJcY1OatIUHwCxAUwklaE,43
+pyxecm_api/terminal/router.py,sha256=cYL93inAB9qux-IFg-TpZjdRHWF_OSkbABlXyG69ukc,3582
+pyxecm_api/v1_csai/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_csai/models.py,sha256=c0VEJP09jsTW83dpHtZnooNvg3SZNuyMHEBCgWQDJ1s,489
+pyxecm_api/v1_csai/router.py,sha256=5MuzlVzUTEjgBTE2yGtvplt2jekxS4zcl_lqUcz3LVU,5198
+pyxecm_api/v1_csai/statics/bindings/utils.js,sha256=MRPHMxfDDJnqr7x4KRYWDOfSMYOhSGFdoElmQ-lWDLA,6311
+pyxecm_api/v1_csai/statics/tom-select/tom-select.complete.min.js,sha256=f2dQEyWhXp7M5o3MsmgS6zJ_Gq4pXFxSxSTsYrPxPc0,44776
+pyxecm_api/v1_csai/statics/tom-select/tom-select.css,sha256=JgqUGftl29aF9fEJ-ObePYuXmhVAUK-Tp2GiLTTt54Q,9328
+pyxecm_api/v1_csai/statics/vis-9.1.2/vis-network.css,sha256=LoLURa1YeOqIFlJHDOYyYB-PVfG5nm6-zf-GFGAObQ4,220163
+pyxecm_api/v1_csai/statics/vis-9.1.2/vis-network.min.js,sha256=HyDwc28yy5vt-PY4OyXP6i-Dnhq-gNboBAtNW-o3jGk,468813
+pyxecm_api/v1_maintenance/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_maintenance/functions.py,sha256=NDU08aHzPi7KXxKMA4KPHwc-LkpiqqwZU7Wif8yjaJk,3001
+pyxecm_api/v1_maintenance/models.py,sha256=HcrhBg9hhRZg4Y6xuus9T8SCNIsL8ZxX1uuaRrBnFBw,271
+pyxecm_api/v1_maintenance/router.py,sha256=gL_f_-9Slq7yzzOO1uS1aB8N3GduKnm1__7b6cSH7VI,2238
+pyxecm_api/v1_otcs/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_otcs/functions.py,sha256=YKC4b6nVtlnBGcu2WqSRLmS3faXagkAokrBMXUblkJE,2012
+pyxecm_api/v1_otcs/router.py,sha256=VCtGmObA2TVJREwx4mA047SzSpsJlfxhRXA6DdlppZw,7055
+pyxecm_api/v1_payload/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_payload/functions.py,sha256=xA06ACS4NWUut0FXfrw6Ww-R94y43PVSESyEiZEhKAA,6295
+pyxecm_api/v1_payload/models.py,sha256=eD9A2K23L_cGhBDTO1FGVGJMQ1COaYWmcr-ELE66tOA,1006
+pyxecm_api/v1_payload/router.py,sha256=2twiLBeNNDGIEQ6SCZwLFgd8oYOzgbskS-Q3OL-lKe4,15441
+pyxecm_customizer/__init__.py,sha256=x2NhDlNcubRC-jXzqT02j9kQGXBo36QAehjmcQuSbXw,721
+pyxecm_customizer/__main__.py,sha256=QGQlJJAdLmJccArwPT8XEhBOMSJ-Z8gwLrtHPNfL8Ps,1407
+pyxecm_customizer/browser_automation.py,sha256=gWYJVkVMOer7LyQNq_lwyCb0-Ixaf3VaWM7WrpqKMKY,71360
+pyxecm_customizer/customizer.py,sha256=Nzz3wndPp9r5GVpOzLtdNUOuIsCZ2GYdIS1HhWdboBM,84938
+pyxecm_customizer/exceptions.py,sha256=YXX0in-UGXfJb6Fei01JQetOtAHqUiITb49OTSaZRkE,909
+pyxecm_customizer/guidewire.py,sha256=u_mGZU5Nedm-cGf5hUCWE38U-75qoqwi7cq-G3qHty0,67167
+pyxecm_customizer/k8s.py,sha256=DcxLKKuvV3S4DYqP4jUygn32aeGtD0c1FOXumZzqqdY,55837
+pyxecm_customizer/knowledge_graph.py,sha256=Jdm-WVftunoLztinWSPUNhRZ8DhRAVIEcQJJz57opGk,46429
+pyxecm_customizer/log.py,sha256=2DmGF3b-ZIOAJCPSmZmxGD7BNxY4-mZm0H_X0HeJedE,916
+pyxecm_customizer/m365.py,sha256=xQGdY9ti44e93c5tPbgCHjvrM-SjQr2F1iApJMb0-Pk,213957
+pyxecm_customizer/payload.py,sha256=bMyXLMBlio1WuLgKfy9z8LICxFSKg05JDy8qrxRn6M4,1366630
+pyxecm_customizer/payload_list.py,sha256=MCpCzarmQ-5u7FSW7djNOMSjv373Ltx-9rEDIuhEboI,28266
+pyxecm_customizer/salesforce.py,sha256=lGkQcEYg5YIWc7SF2TELT6yfgrn4pnbCrf8wXGk-PMc,64557
+pyxecm_customizer/sap.py,sha256=lD_riOZhYjbZ0_pUZyqhxP6guzBM__TcUjZhSgDowoE,6506
+pyxecm_customizer/servicenow.py,sha256=K26DQiXd-SMMyft9CLCKtw_vb3oKf6VGdTEzm7XMqYI,66292
+pyxecm_customizer/settings.py,sha256=SPm6sBFiMMuFquNwKBnkUcqPZLtVBQ5K6CGjsLJNaOc,21409
+pyxecm_customizer/successfactors.py,sha256=CcWGXwYcqp4jJ805XQZfY50iXcCEiJg6uVUq5AjRqXs,38661
+pyxecm_customizer/translate.py,sha256=TViU9Erp4lXzZi2jQSmBpjVWS0kIW-I_Y5C0z25z-tQ,4960
+pyxecm_maintenance_page/__init__.py,sha256=09to4a8rygOIN6Z1SCN9tLtW1qPUC78Z-scDbpt0E-Q,136
+pyxecm_maintenance_page/__main__.py,sha256=N_0tw2upUPQZhTYCaIr75LogyaEsp-mlZCon-lIyaxM,158
+pyxecm_maintenance_page/app.py,sha256=pTOeZfgPPq6BT7P8naUjW-ZT9dXqwX6DWazIVL-9Fkc,1997
+pyxecm_maintenance_page/settings.py,sha256=VRReZeNdza7i7lgnQ3wVojzoPDGXZnzr5rsMJY1EnHk,955
+pyxecm_maintenance_page/static/favicon.avif,sha256=POuuPXKbjHVP3BjNLpFIx8MfkQg5z2LZA7sK6lejARg,1543
+pyxecm_maintenance_page/templates/maintenance.html,sha256=0OAinv7jmj3Aa7GNCIoBLDGEMW1-_HdJfwWmkmb6Cs4,5581
+pyxecm-3.1.1.dist-info/METADATA,sha256=9ZjC6c_J6K4UBCgohLC_Fz9THffRsXPPq41fPl5Wpoo,4566
+pyxecm-3.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyxecm-3.1.1.dist-info/entry_points.txt,sha256=prc1mDdpd3bQk98VRBozI363mDUgSwDibDKXGNqKqgI,151
+pyxecm-3.1.1.dist-info/RECORD,,

pyxecm_api/app.py

@@ -8,7 +8,6 @@ __email__ = "mdiefenb@opentext.com"
 
 import logging
 import os
-import threading
 from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
 from datetime import UTC, datetime
@@ -23,9 +22,6 @@ from prometheus_fastapi_instrumentator import Instrumentator
 from pyxecm.helper.otel_config import tracer
 from pyxecm_maintenance_page import run_maintenance_page
 
-from .agents.app import agent_routers
-from .agents.functions import register_all
-from .agents.otcm_knowledgegraph.functions import build_graph
 from .auth.router import router as auth_router
 from .common.functions import PAYLOAD_LIST
 from .common.metrics import payload_logs_by_payload, payload_logs_total
@@ -50,31 +46,20 @@ if os.path.isfile(os.path.join(api_settings.logfolder, api_settings.logfile)):
 elif not os.path.exists(api_settings.logfolder):
     os.makedirs(api_settings.logfolder)
 
-handlers = [logging.FileHandler(os.path.join(api_settings.logfolder, api_settings.logfile))]
-if api_settings.log_payload_processing:
-    handlers.append(logging.StreamHandler())
-
-logging.basicConfig(
-    format="%(asctime)s %(levelname)s [%(name)s] [%(threadName)s] %(message)s",
-    datefmt="%d-%b-%Y %H:%M:%S",
-    level=api_settings.loglevel,
-    handlers=handlers,
-)
-
 
 @asynccontextmanager
 async def lifespan(
     app: FastAPI,  # noqa: ARG001
 ) -> AsyncGenerator:
-    """Lifespan Method for FASTAPI to handle the startup and shutdown process.
+    """Lifespan function for FASTAPI to handle the startup and shutdown process.
 
     Args:
         app (FastAPI):
-            The application.
+            The FastAPI application.
 
     """
 
-    logger.debug("Settings -> %s", api_settings)
+    logger.debug("API settings -> %s", api_settings)
 
     with tracer.start_as_current_span("import_payloads"):
         if api_settings.import_payload:
@@ -89,20 +74,18 @@ async def lifespan(
             # Optional Payload
             import_payload(payload_dir=api_settings.payload_dir_optional)
 
-    logger.info("Starting maintenance_page thread...")
+    logger.info("Starting maintenance page thread...")
     if api_settings.maintenance_page:
         run_maintenance_page()
 
-    if api_settings.csai_studio_integration:
-        logger.info("Registering Content Aviator tools...")
-        register_all()
-        threading.Thread(name="KnowledgeGraph", target=build_graph).start()
-
     yield
+
     logger.info("Shutdown")
     PAYLOAD_LIST.stop_payload_processing()
 
 
+# end function lifespan
+
 app = FastAPI(
     docs_url="/api",
     title=api_settings.title,
@@ -114,7 +97,7 @@ app = FastAPI(
     openapi_tags=[
         {
             "name": "auth",
-            "description": "Authentication Endpoint - Users are authenticated against Opentext Directory Services",
+            "description": "Authentication Endpoint - Users are authenticated against OpenText Directory Services",
         },
         {
             "name": "payload",
@@ -156,8 +139,6 @@ if api_settings.csai:
     )
 
     app.include_router(router=v1_csai_router)
-    for agent_router in agent_routers:
-        app.include_router(prefix="/agents", router=agent_router)
 
 
 ## Add Prometheus Instrumentator for /metrics,
@@ -170,7 +151,7 @@ if api_settings.metrics:
 
 ## Start the API Server
 def run_api() -> None:
-    """Start the FASTAPI Webserver."""
+    """Start the FastAPI Webserver."""
 
     # Check if Temp and Log dir exists
     if not os.path.exists(api_settings.temp_dir):
@@ -183,27 +164,56 @@ def run_api() -> None:
         customizer_start_time = datetime.now(UTC).strftime(
             "%Y-%m-%d_%H-%M",
         )
-        api_settings.logfile = f"customizer_{customizer_start_time}.log"
+        api_settings.logfile = "customizer_{}.log".format(customizer_start_time)
 
     # Configure Logging for uvicorn
     log_config = uvicorn.config.LOGGING_CONFIG
 
     # Stdout
-    log_config["formatters"]["pyxecm"] = {
+    log_config["formatters"]["standard"] = {
         "()": "uvicorn.logging.DefaultFormatter",
         "fmt": "%(levelprefix)s [%(name)s] [%(threadName)s] %(message)s",
         "use_colors": True,
     }
-    log_config["handlers"]["pyxecm"] = {
-        "formatter": "pyxecm",
+
+    log_config["formatters"]["logfile"] = {
+        "()": "uvicorn.logging.DefaultFormatter",
+        "fmt": "%(asctime)s %(levelname)s [%(name)s] [%(threadName)s] %(message)s",
+        "datefmt": "%d-%b-%Y %H:%M:%S",
+        "use_colors": True,
+    }
+
+    log_config["formatters"]["accesslog"] = {
+        "()": "uvicorn.logging.AccessFormatter",
+        "fmt": '%(levelprefix)s %(client_addr)s - "%(request_line)s" %(status_code)s',
+        "use_colors": False,
+    }
+
+    log_config["handlers"]["console"] = {
+        "formatter": "standard",
         "class": "logging.StreamHandler",
         "stream": "ext://sys.stdout",
     }
 
-    log_config["loggers"]["pyxecm"] = {
-        "handlers": ["pyxecm"],
+    log_config["handlers"]["file"] = {
+        "formatter": "logfile",
+        "class": "logging.FileHandler",
+        "filename": os.path.join(api_settings.logfolder, api_settings.logfile),
+        "mode": "a",
+    }
+
+    log_config["handlers"]["accesslog"] = {
+        "formatter": "accesslog",
+        "class": "logging.FileHandler",
+        "filename": os.path.join(api_settings.logfolder, "access.log"),
+        "mode": "a",
+    }
+
+    log_config["loggers"]["uvicorn.access"]["handlers"] = ["access", "accesslog"]
+
+    log_config["loggers"]["root"] = {
         "level": api_settings.loglevel,
-        "propagate": False,
+        "handlers": ["console", "file"],
     }
 
     logger.info("Starting processing thread...")

pyxecm_api/auth/functions.py

@@ -27,8 +27,8 @@ def get_groups(response: dict, token: str) -> list:
     """Get the groups of the user.
 
     Args:
-        response (_type_): _description_
-        token (_type_): _description_
+        response (dict): _description_
+        token (str): _description_
 
     Returns:
         list: _description_

pyxecm_api/auth/router.py

@@ -64,9 +64,8 @@ async def login(form_data: Annotated[OAuth2PasswordRequestForm, Depends()]) -> J
 async def read_users_me(current_user: Annotated[User, Depends(get_current_user)]) -> JSONResponse:
     """Get the current user.
 
-    current_user:
-        type: User
-        description: The current user.
+    current_user (User):
+        The current user.
 
     """