pyxecm 2.0.4__tar.gz → 3.0.1__tar.gz

pyxecm-3.0.1/.gitignore

@@ -0,0 +1,25 @@
+public/
+dist/
+pyxecm.egg-info/
+pyxecm/__pycache__/
+.venv/
+.debug/
+pyxecm/helper/__pycache__/
+__pycache__
+build/
+.env
+~$*
+debug/logs/
+.env.*
+.ruff_cache
+uv.lock
+customizerapisettings_doc.md
+customizerapisettings.env
+customizerapisettings.md
+customizersettings_doc.md
+customizersettings.env
+coverage.xml
+junit.xml
+.coverage
+lib/
+/root.html

pyxecm-3.0.1/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: pyxecm
+Version: 3.0.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>
+Keywords: appworks,archivecenter,contentserver,extendedecm,opentext,otds
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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-Dist: lxml>=6.0.0
+Requires-Dist: opentelemetry-api>=1.34.1
+Requires-Dist: opentelemetry-exporter-otlp>=1.34.1
+Requires-Dist: opentelemetry-instrumentation-requests>=0.55b1
+Requires-Dist: opentelemetry-instrumentation-threading>=0.55b1
+Requires-Dist: opentelemetry-sdk>=1.34.1
+Requires-Dist: pandas>=2.3.1
+Requires-Dist: requests-toolbelt>=1.0.0
+Requires-Dist: requests>=2.32.4
+Requires-Dist: suds>=1.2.0
+Requires-Dist: websockets>=15.0.1
+Requires-Dist: xmltodict>=0.14.2
+Provides-Extra: api
+Requires-Dist: asyncio>=3.4.3; extra == 'api'
+Requires-Dist: fastapi>=0.116.0; extra == 'api'
+Requires-Dist: jinja2>=3.1.6; extra == 'api'
+Requires-Dist: opentelemetry-api>=1.34.1; extra == 'api'
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.55b1; extra == 'api'
+Requires-Dist: opentelemetry-sdk>=1.34.1; extra == 'api'
+Requires-Dist: prometheus-fastapi-instrumentator>=7.1.0; extra == 'api'
+Requires-Dist: pydantic-settings>=2.10.1; extra == 'api'
+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: playwright>=1.53.0; extra == 'customizer'
+Requires-Dist: pydantic>=2.11.7; extra == 'customizer'
+Requires-Dist: python-hcl2>=7.2.1; extra == 'customizer'
+Provides-Extra: magic
+Requires-Dist: python-magic; extra == 'magic'
+Provides-Extra: pyvis
+Requires-Dist: pyvis>=0.3.2; extra == 'pyvis'
+Provides-Extra: sap
+Requires-Dist: pyrfc==3.3.1; extra == 'sap'
+Description-Content-Type: text/markdown
+
+# PYXECM
+
+A python library to interact with Opentext Content Mangement REST API.
+The product API documentation is available on [OpenText Developer](https://developer.opentext.com/ce/products/extendedecm)
+Detailed documentation of this package is available [here](https://opentext.github.io/pyxecm/).
+
+## Quick start - Library usage
+
+Install the latest version from pypi:
+
+```bash
+pip install pyxecm
+```
+
+### Start using the package libraries
+
+example usage of the OTCS class, more details can be found in the docs:
+
+```python
+from pyxecm import OTCS
+
+otcs_object = OTCS(
+    protocol="https",
+    hostname="otcs.domain.tld",
+    port="443",
+    public_url="otcs.domain.tld",
+    username="admin",
+    password="********",
+    base_path="/cs/llisapi.dll",
+)
+
+otcs_object.authenticate()
+
+nodes = otcs_object.get_subnodes(2000)
+
+for node in nodes["results"]:
+    print(node["data"]["properties"]["id"], node["data"]["properties"]["name"])
+```
+
+## Quick start - Customizer usage
+
+- Create an `.env` file as described here: [sample-environment-variables](customizerapisettings/#sample-environment-variables)
+- Create an payload file to define what the customizer should do, as described here [payload-syntax](payload-syntax)
+
+```bash
+pip install pyxecm[customizer]
+
+pyxecm-customizer PAYLOAD.tfvars/PAYLOAD.yaml
+```
+
+## Quick start - API 
+
+- Install pyxecm with api and customizer dependencies
+- Launch the Rest API server
+- Access the Customizer API at [http://localhost:8000/api](http://localhost:8000/api)
+
+```bash
+pip install pyxecm[api,customizer]
+
+pyxecm-api
+```
+
+## Disclaimer
+
+
+Copyright © 2025 Open Text Corporation, All Rights Reserved.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyxecm-3.0.1/README.md

@@ -0,0 +1,76 @@
+# PYXECM
+
+A python library to interact with Opentext Content Mangement REST API.
+The product API documentation is available on [OpenText Developer](https://developer.opentext.com/ce/products/extendedecm)
+Detailed documentation of this package is available [here](https://opentext.github.io/pyxecm/).
+
+## Quick start - Library usage
+
+Install the latest version from pypi:
+
+```bash
+pip install pyxecm
+```
+
+### Start using the package libraries
+
+example usage of the OTCS class, more details can be found in the docs:
+
+```python
+from pyxecm import OTCS
+
+otcs_object = OTCS(
+    protocol="https",
+    hostname="otcs.domain.tld",
+    port="443",
+    public_url="otcs.domain.tld",
+    username="admin",
+    password="********",
+    base_path="/cs/llisapi.dll",
+)
+
+otcs_object.authenticate()
+
+nodes = otcs_object.get_subnodes(2000)
+
+for node in nodes["results"]:
+    print(node["data"]["properties"]["id"], node["data"]["properties"]["name"])
+```
+
+## Quick start - Customizer usage
+
+- Create an `.env` file as described here: [sample-environment-variables](customizerapisettings/#sample-environment-variables)
+- Create an payload file to define what the customizer should do, as described here [payload-syntax](payload-syntax)
+
+```bash
+pip install pyxecm[customizer]
+
+pyxecm-customizer PAYLOAD.tfvars/PAYLOAD.yaml
+```
+
+## Quick start - API 
+
+- Install pyxecm with api and customizer dependencies
+- Launch the Rest API server
+- Access the Customizer API at [http://localhost:8000/api](http://localhost:8000/api)
+
+```bash
+pip install pyxecm[api,customizer]
+
+pyxecm-api
+```
+
+## Disclaimer
+
+
+Copyright © 2025 Open Text Corporation, All Rights Reserved.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyxecm-3.0.1/pyproject.toml

@@ -0,0 +1,88 @@
+[project]
+name = "pyxecm"
+version = "3.0.1"
+description = 'A Python library to interact with Opentext Content Management Rest API'
+keywords = [
+  'opentext',
+  'extendedecm',
+  'contentserver',
+  'otds',
+  'appworks',
+  'archivecenter',
+]
+readme = "README.md"
+authors = [
+  { name = "Kai Gatzweiler", email = "kgatzweiler@opentext.com" },
+  { name = "Dr. Marc Diefenbruch", email = "mdiefenb@opentext.com" },
+]
+requires-python = '>=3.10'
+dependencies = [
+  "lxml>=6.0.0",
+  "opentelemetry-api>=1.34.1",
+  "opentelemetry-exporter-otlp>=1.34.1",
+  "opentelemetry-instrumentation-requests>=0.55b1",
+  "opentelemetry-instrumentation-threading>=0.55b1",
+  "opentelemetry-sdk>=1.34.1",
+  "pandas>=2.3.1",
+  "requests>=2.32.4",
+  "requests-toolbelt>=1.0.0",
+  "suds>=1.2.0",
+  "websockets>=15.0.1",
+  "xmltodict>=0.14.2",
+]
+classifiers = [
+  'Development Status :: 4 - Beta',
+  'Programming Language :: Python :: 3',
+  'License :: OSI Approved :: Apache Software License',
+  'Operating System :: OS Independent',
+  'Intended Audience :: Developers',
+  'Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System',
+]
+
+[project.optional-dependencies]
+magic = ['python-magic']
+sap = ['pyrfc==3.3.1']
+pyvis = ["pyvis>=0.3.2"]
+customizer = [
+  "kubernetes>=33.1.0",
+  "playwright>=1.53.0",
+  "pydantic>=2.11.7",
+  "python-hcl2>=7.2.1",
+]
+api = [
+  "asyncio>=3.4.3",
+  "fastapi>=0.116.0",
+  "jinja2>=3.1.6",
+  "opentelemetry-api>=1.34.1",
+  "opentelemetry-instrumentation-fastapi>=0.55b1",
+  "opentelemetry-sdk>=1.34.1",
+  "prometheus-fastapi-instrumentator>=7.1.0",
+  "pydantic-settings>=2.10.1",
+  "python-multipart>=0.0.20",
+  "uvicorn>=0.35.0",
+]
+
+[project.urls]
+Homepage = 'https://github.com/opentext/pyxecm' 
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = [
+  "src/pyxecm",
+  "src/pyxecm_api",
+  "src/pyxecm_customizer",
+  "src/pyxecm_maintenance_page",
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+  "tests/**"
+]
+
+[project.scripts]
+pyxecm-api = "pyxecm_api:run_api"
+pyxecm-customizer = "pyxecm_customizer:main"
+pyxecm-maintenance-page = "pyxecm_maintenance_page:run_api"

{pyxecm-2.0.4 → pyxecm-3.0.1/src}/pyxecm/coreshare.py

@@ -2590,7 +2590,8 @@ class CoreShare:
         is_confirmed = self.get_result_value(response=user, key="isConfirmed")
         if not is_confirmed:
             self.logger.info(
-                "User -> %s is not yet confirmed - so it cannot have files to cleanup.",
+                "User -> %s (%s) is not yet confirmed - so it cannot have files to cleanup.",
+                user_login,
                 user_id,
             )
             return True
@@ -2612,14 +2613,15 @@ class CoreShare:
         # Get all folders of the user:
         response = self.get_folders(parent_id=user_root_folder_id)
         if not response or not response["results"]:
-            self.logger.info("User -> %s has no items to cleanup!", user_id)
+            self.logger.info("User -> %s (%s) has no items to cleanup!", user_login, user_id)
         else:
             items = response["results"]
             for item in items:
                 if item["isShared"]:
                     if item["owner"]["id"] == user_id:
                         self.logger.info(
-                            "User -> %s stops sharing item -> %s (%s)...",
+                            "User -> %s (%s) stops sharing item -> %s (%s)...",
+                            user_login,
                             user_id,
                             item["name"],
                             item["id"],

{pyxecm-2.0.4 → pyxecm-3.0.1/src}/pyxecm/helper/data.py

@@ -1410,7 +1410,7 @@ class Data:
             for value in values:
                 # Do we want a special treatment for this value (e.g. the current year)
                 if value in special_values:
-                    self.logger.info("Processing special value -> '%s'...", value)
+                    self.logger.debug("Processing special value -> '%s'...", value)
                     if value not in special_url_templates and str(value) not in special_url_templates:
                         self.logger.error(
                             "Cannot find key -> '%s' in special URL templates dictionary -> %s! Skipping...",
@@ -2127,7 +2127,7 @@ class Data:
                     )
                     continue
                 # Apply cleansing to dictionary values in the main column
-                self.logger.info(
+                self.logger.debug(
                     "Cleansing for column -> '%s' has a subfield -> '%s' configured. Do cleansing for dictionary items with key -> '%s'...",
                     column,
                     dict_key,
@@ -2165,7 +2165,7 @@ class Data:
                 # Handle string columns:
                 if self.is_string_column(self._df[column]):
                     # Apply cleansing operations on string column
-                    self.logger.info(
+                    self.logger.debug(
                         "Column -> '%s' has string values. Do cleansing for string values...",
                         column,
                     )
@@ -2195,7 +2195,7 @@ class Data:
                 elif self.is_list_column(self._df[column]):
                     # Handle list-like columns for this we iterate over each list item
                     # and apply the cleansing by calling _apply_string_cleansing() for item:
-                    self.logger.info(
+                    self.logger.debug(
                         "Column -> '%s' has list values. Do cleansing for each list item...",
                         column,
                     )

pyxecm-3.0.1/src/pyxecm/helper/otel_config.py

@@ -0,0 +1,26 @@
+"""Define OpenTelemtry configuration."""
+
+import os
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.instrumentation.requests import RequestsInstrumentor
+from opentelemetry.instrumentation.threading import ThreadingInstrumentor
+from opentelemetry.sdk.resources import SERVICE_NAME, Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+
+resource = Resource.create(attributes={SERVICE_NAME: "pyxecm"})
+
+trace.set_tracer_provider(TracerProvider(resource=resource))
+
+if os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT"):
+    trace.get_tracer_provider().add_span_processor(
+        BatchSpanProcessor(OTLPSpanExporter()),
+    )
+
+# Auto-instrument requests
+RequestsInstrumentor().instrument()
+ThreadingInstrumentor().instrument()
+
+tracer = trace.get_tracer("pyxecm")

{pyxecm-2.0.4 → pyxecm-3.0.1/src}/pyxecm/helper/web.py

@@ -326,8 +326,7 @@ class HTTP:
                 )
                 os.makedirs(directory)
             with open(filename, "wb") as download_file:
-                for chunk in response.iter_content(chunk_size=chunk_size):
-                    download_file.write(chunk)
+                download_file.writelines(response.iter_content(chunk_size=chunk_size))
             self.logger.debug(
                 "File downloaded successfully as -> '%s' (size -> %s).",
                 filename,