pyxecm 1.6__tar.gz → 2.0.0__tar.gz

pyxecm-2.0.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: pyxecm
+Version: 2.0.0
+Summary: A Python library to interact with Opentext Extended ECM REST API
+Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>
+Project-URL: Homepage, https://github.com/opentext/pyxecm
+Keywords: opentext,extendedecm,contentserver,otds,appworks,archivecenter
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3
+Requires-Dist: requests_toolbelt
+Requires-Dist: setuptools
+Requires-Dist: kubernetes
+Requires-Dist: zipfile36
+Requires-Dist: suds
+Requires-Dist: python-hcl2
+Requires-Dist: xmltodict
+Requires-Dist: lxml
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: python-magic
+Requires-Dist: websockets
+Requires-Dist: pydantic-settings
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: python-multipart
+Requires-Dist: aiofiles
+Requires-Dist: asyncio
+Requires-Dist: jinja2
+Requires-Dist: prometheus-fastapi-instrumentator
+Provides-Extra: browserautomation
+Requires-Dist: selenium; extra == "browserautomation"
+Requires-Dist: chromedriver_autoinstaller; extra == "browserautomation"
+Provides-Extra: dataloader
+Requires-Dist: pandas; extra == "dataloader"
+Requires-Dist: pyyaml; extra == "dataloader"
+Requires-Dist: python-hcl2; extra == "dataloader"
+Requires-Dist: tropycal; extra == "dataloader"
+Requires-Dist: shapely; extra == "dataloader"
+Requires-Dist: cartopy; extra == "dataloader"
+Provides-Extra: sap
+Requires-Dist: pyrfc==2.8.3; extra == "sap"
+Provides-Extra: profiling
+Requires-Dist: pyinstrument; extra == "profiling"
+Dynamic: license-file
+
+# PYXECM
+
+A python library to interact with Opentext Extended ECM 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
+
+Install pyxecm with the desired extras into your python environment, extra options are:
+
+    - browserautomation
+    - dataloader
+    - sap
+
+```bash
+pip install pyxecm
+```
+
+## Start using the Customizer
+
+Create an `.env` file as described here: [sample-environment-variables](customizerapisettings/#sample-environment-variables)
+
+```bash
+python -m pyxecm.customizer.api
+```
+
+??? example "Sample Output"
+    ```console
+    INFO:     Started server process [93861]
+    INFO:     Waiting for application startup.
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI] [MainThread] Starting maintenance_page thread...
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI] [MainThread] Starting processing thread...
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI.payload_list] [customization_run_api] Starting 'Scheduler' thread for payload list processing...
+    INFO:     Application startup complete.
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI.payload_list] [customization_run_api] Waiting for thread -> 'Scheduler' to complete...
+    INFO:     Started server process [93861]
+    INFO:     Waiting for application startup.
+    INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
+    INFO:     Application startup complete.
+    INFO:     Uvicorn running on http://0.0.0.0:5555 (Press CTRL+C to quit)
+    ```
+
+Access the Customizer API at [http://localhost:8000/api](http://localhost:8000/api)
+
+
+## Start using the package libraries
+```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"])
+```
+??? example "Sample Output"
+    ```console
+    13050 Administration
+    13064 Case Management
+    18565 Contract Management
+    18599 Customer Support
+    18536 Engineering & Construction
+    13107 Enterprise Asset Management
+    18632 Human Resources
+    6554 Inbox Folders
+    ```
+
+# Disclaimer
+
+!!! quote ""
+    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-2.0.0/README.md

@@ -0,0 +1,92 @@
+# PYXECM
+
+A python library to interact with Opentext Extended ECM 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
+
+Install pyxecm with the desired extras into your python environment, extra options are:
+
+    - browserautomation
+    - dataloader
+    - sap
+
+```bash
+pip install pyxecm
+```
+
+## Start using the Customizer
+
+Create an `.env` file as described here: [sample-environment-variables](customizerapisettings/#sample-environment-variables)
+
+```bash
+python -m pyxecm.customizer.api
+```
+
+??? example "Sample Output"
+    ```console
+    INFO:     Started server process [93861]
+    INFO:     Waiting for application startup.
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI] [MainThread] Starting maintenance_page thread...
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI] [MainThread] Starting processing thread...
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI.payload_list] [customization_run_api] Starting 'Scheduler' thread for payload list processing...
+    INFO:     Application startup complete.
+    31-Mar-2025 12:49:53 INFO [CustomizerAPI.payload_list] [customization_run_api] Waiting for thread -> 'Scheduler' to complete...
+    INFO:     Started server process [93861]
+    INFO:     Waiting for application startup.
+    INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
+    INFO:     Application startup complete.
+    INFO:     Uvicorn running on http://0.0.0.0:5555 (Press CTRL+C to quit)
+    ```
+
+Access the Customizer API at [http://localhost:8000/api](http://localhost:8000/api)
+
+
+## Start using the package libraries
+```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"])
+```
+??? example "Sample Output"
+    ```console
+    13050 Administration
+    13064 Case Management
+    18565 Contract Management
+    18599 Customer Support
+    18536 Engineering & Construction
+    13107 Enterprise Asset Management
+    18632 Human Resources
+    6554 Inbox Folders
+    ```
+
+# Disclaimer
+
+!!! quote ""
+    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-2.0.0/pyproject.toml

@@ -0,0 +1,125 @@
+[build-system]
+build-backend = 'setuptools.build_meta'
+requires = ['setuptools >= 61.0']
+
+[project]
+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',
+]
+dependencies = [
+  'requests < 3',
+  'requests_toolbelt',
+  'setuptools',
+  'kubernetes',
+  'zipfile36',
+  'suds',
+  'python-hcl2',
+  'xmltodict',
+  'lxml',
+  'openpyxl',
+  'pandas',
+  'python-magic',
+  'websockets',
+  'pydantic-settings',
+  'fastapi',
+  'uvicorn',
+  'python-multipart',
+  'aiofiles',
+  'asyncio',
+  'jinja2',
+  'prometheus-fastapi-instrumentator'  
+]
+description = 'A Python library to interact with Opentext Extended ECM REST API'
+keywords = [
+  'opentext',
+  'extendedecm',
+  'contentserver',
+  'otds',
+  'appworks',
+  'archivecenter',
+]
+name = 'pyxecm'
+readme = 'README.md'
+requires-python = '>=3.10'
+version = "2.0.0"
+
+[[project.authors]]
+email = 'kgatzweiler@opentext.com'
+name = 'Kai Gatzweiler'
+
+[[project.authors]]
+email = 'mdiefenb@opentext.com'
+name = 'Dr. Marc Diefenbruch'
+
+[project.optional-dependencies]
+browserautomation = ['selenium', 'chromedriver_autoinstaller']
+dataloader = [
+  'pandas',
+  'pyyaml',
+  'python-hcl2',
+  'tropycal',
+  'shapely',
+  'cartopy',
+]
+sap = ['pyrfc==2.8.3']
+profiling = [
+  'pyinstrument',
+]
+
+[project.urls]
+Homepage = 'https://github.com/opentext/pyxecm'
+
+[tool]
+[tool.setuptools]
+packages = [
+  'pyxecm',
+  'pyxecm.customizer',
+  'pyxecm.customizer.api',
+  'pyxecm.maintenance_page',
+  'pyxecm.maintenance_page.templates',
+  'pyxecm.maintenance_page.static',
+  'pyxecm.helper',
+]
+
+[tool.setuptools.package-data]
+'pyxecm.maintenance_page.templates' = ['*']
+'pyxecm.maintenance_page.static' = ['*']
+
+[tool.ruff.lint]
+# https://docs.astral.sh/ruff/rules/
+select = ["ALL"]
+
+# E4: Enforces Python-specific formatting and style rules, often related to imports and code layout (e.g., E402, module-level import not at top of file).
+# E7: Relates to errors in Python syntax or usage, such as invalid expressions.
+# E9: Catches Python runtime errors (e.g., undefined variables, unsupported operations).
+# F: Stands for "Flake8" rules, which include a broad range of Python style and error checks (e.g., unused imports, undefined variables, etc.).
+# FIX: Selects rules that Ruff can automatically fix (e.g., applying auto-corrections for code style violations).
+# I: Relates to "Import" rules, which enforce best practices for managing Python imports (e.g., sorting imports, unused imports, etc.).
+# UP032: Prevents Ruff from converting .format() calls to f-strings.
+# D204 and D205: Prevents Ruff from enforcing changes to empty lines after docstrings.
+
+ignore = ["FIX002", "TD002", "TD003", "BLE001", "ERA001", "S105", "S106", "S107", "S113", "S311", "S314", "S603", "S608", "RUF005", "RUF012", "E501", "PERF203", "UP038", "PLW2901", "PD002", "PD901", "UP032", "D202", "D203", "D213", "PLR0911", "PLR0912", "PLR0913", "PLR0915", "PLR2004", "PTH", "PTH123", "PTH103", "PTH104", "PTH107", "PTH110", "PTH112", "PTH113", "PTH118", "PTH119", "PTH120", "PTH122", "FBT001", "FBT002", "RET504", "RET505", "C901", "B019", "TRY400", "COM812"]
+fixable = ["ALL"]
+unfixable = []
+
+[dependency-groups]
+dev = [
+  'pdoc3',
+  'mkdocs',
+  'mkdocstrings[python]',
+  'mkdocs-material',
+  'mkdocs-git-revision-date-localized-plugin',
+  'pymdown-extensions',
+  "ruff",
+  'python-decouple',
+  'settings-doc',
+]
+
+[tool.ruff]
+line-length = 120
+exclude = []

{pyxecm-1.6 → pyxecm-2.0.0}/pyxecm/__init__.py

@@ -1,11 +1,13 @@
 """pyxecm - A python library to interact with Opentext Extended ECM REST API."""
 
+from .avts import AVTS
+from .coreshare import CoreShare
 from .otac import OTAC
+from .otawp import OTAWP
 from .otcs import OTCS
 from .otds import OTDS
 from .otiv import OTIV
-from .otpd import OTPD
 from .otmm import OTMM
-from .otawp import OTAWP
-from .avts import AVTS
-from .coreshare import CoreShare
+from .otpd import OTPD
+
+__all__ = ["AVTS", "OTAC", "OTAWP", "OTCS", "OTDS", "OTIV", "OTMM", "OTPD", "CoreShare"]