pyxecm 1.5__py3-none-any.whl → 2.0.0__py3-none-any.whl

pyxecm-2.0.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,54 @@
+pyxecm/__init__.py,sha256=bR3w0DYfGhluEa6Hp0jhzpltjWVjwLIG9dYSynZZbEY,391
+pyxecm/avts.py,sha256=CK8EK0qxegbUrsiYVH89jS5W7TDVYjdl_ByOcCw6k3U,55311
+pyxecm/coreshare.py,sha256=wIwJk_t29I4oxwn0T67Cy8Pyl7XpjrNDwN8_udXldF4,93298
+pyxecm/otac.py,sha256=F0ca8mE2BFlR0x3A6mV-dKEo4hzP7--gqsCv4-i2qeE,22839
+pyxecm/otawp.py,sha256=U5pOtQf-1jFiZ7XhXkd64zGA8SATRc1Jyb93ArUzAes,95799
+pyxecm/otcs.py,sha256=4ky7px5v6Nj5PfCZSTRCTQhSHUk7TsAl4N3Avuq4p80,581473
+pyxecm/otds.py,sha256=O6diWtuXAp27kWkfOCEWI5oZJfbnnAZpWbAT9xySu_w,183774
+pyxecm/otiv.py,sha256=I5lt4sz7TN3W7BCstCKQY2WQnei-t0tXdM4QjRQRmWI,2358
+pyxecm/otmm.py,sha256=ovjCfzoeuxH5R7v7f_GVSEn7zvaN1sSHsrtQ_PRLeP8,74819
+pyxecm/otpd.py,sha256=6rfCoO5Jm6pETCyp6aKYNTyvI1z44wP76zS-qRotyVk,14831
+pyxecm/customizer/__init__.py,sha256=T39r7ylBXhECDaCQeV2rmgIEO4WJzuC61FSK51cgzBI,512
+pyxecm/customizer/__main__.py,sha256=29JhUCUAcKPohCukMksS02n6J_a8HPkeReWvQ59_Hhs,1499
+pyxecm/customizer/browser_automation.py,sha256=nd4II1kEVbCVHEDKDNlYB8oT4fpZGLQh5Pqem391Pdg,22357
+pyxecm/customizer/customizer.py,sha256=VYyamfj2-wkqRyuRovcoHFJjE-6_KfGqROjA2Uv1L3k,85516
+pyxecm/customizer/exceptions.py,sha256=YXX0in-UGXfJb6Fei01JQetOtAHqUiITb49OTSaZRkE,909
+pyxecm/customizer/guidewire.py,sha256=Oa2q5cL16bf7q3QDJennM77tUba6DqPwjLRAQVVFvio,9135
+pyxecm/customizer/k8s.py,sha256=Vw578K4645kZG1CGMHn3vbPpkbGZaibDgw7f6a_o71o,47291
+pyxecm/customizer/log.py,sha256=N-EZc822AYWniUb3PCQ8vPZ9ki61ZzMfSprdTDP-jKY,3015
+pyxecm/customizer/m365.py,sha256=7f1GG93eRx8HcdxfMaK5DMOV5lwErB1_peqesRVOx20,209672
+pyxecm/customizer/nhc.py,sha256=Yu2t0lc3CUqpDeZ4RWTNZCsNRz9hG4Bx8-p21ZLYRHM,45647
+pyxecm/customizer/openapi.py,sha256=dI5YQzxBVVeT0TWMzEfOxyPAnM4fAsBt3F1MrAK9jLg,7161
+pyxecm/customizer/payload.py,sha256=rsOUH5VnJg8E8dey8P91cT9l9Gh62GbDF9yejtgPmoE,1231292
+pyxecm/customizer/pht.py,sha256=f7VGsFQlXx3vdYRio8ydo1msadUvG2j3dtg4waORMVA,47520
+pyxecm/customizer/salesforce.py,sha256=MB_8mDUikettUGQpcuG19QQyeNjxq1Z0BF6asQGkgZ8,63518
+pyxecm/customizer/sap.py,sha256=4smnL-epWe9tVrPI7AK1lVUqaEAbyphPWeExV7UfOfc,6388
+pyxecm/customizer/servicenow.py,sha256=ak0MgRZvmftf3bDzHAiPRjHbu1zGsVRg-RBSn6nRIDM,64775
+pyxecm/customizer/settings.py,sha256=3HmEsA7VkTzLh8a1slvJcDQFS20B3EWtNOL_UAmUxI4,19977
+pyxecm/customizer/successfactors.py,sha256=iRoOCiZ9NXSGCzpxViavQKPrHAU1PxMvh7gK8mpRY8o,38299
+pyxecm/customizer/translate.py,sha256=O2I928YQx1F2rucI3eQM2k8oybVfsbUHFikrNt5PAQ8,4788
+pyxecm/customizer/api/__init__.py,sha256=8oXxEEFSu2afpyQURpxMA2qTZAB3MUdbBrndogDn5Oc,92
+pyxecm/customizer/api/__main__.py,sha256=0DvtXJUeOOvpRfcq67CZ0HhE5gI4vLD1UTCAfNXQrT4,128
+pyxecm/customizer/api/app.py,sha256=ayRLsuK_pJz1NQ1BrOfhC9aSWsmldKX56ii87NfJU4M,28508
+pyxecm/customizer/api/auth.py,sha256=z5KQbO7Vlh9T4hz-w1vqgmRdFSGcZnOe_IcBnDw5CKc,4461
+pyxecm/customizer/api/metrics.py,sha256=2sEovK9KL2rEWC0ywi5_bwWKMWdkKho32ZIj37dDqLg,2712
+pyxecm/customizer/api/models.py,sha256=lKebaIHbALZ10quCCKQ3wf7w8V6k84tFXcPV1zbQsS0,271
+pyxecm/customizer/api/payload_list.py,sha256=CAPWmjwinK8bTtrJcQ_9vpJvPZdQBb2N_1bQ1dsUqe0,28390
+pyxecm/customizer/api/settings.py,sha256=tYHIYKoSYcE9IiYI1qEijDkK1DAA0gi9wwI5FaP4pfc,3805
+pyxecm/helper/__init__.py,sha256=B35HdIZC9wZ1m_sx4NOPggyFFJoXmFuA1T2tuPDU1W8,246
+pyxecm/helper/assoc.py,sha256=yOh4GFZEkTfIaVVrHBr4bhMtIv-E76oDVWGqaUdVqyA,7321
+pyxecm/helper/data.py,sha256=Mit8qYWDU_YgK98UtLFPEr2ZNE5xk5lJS_wjyv63-jk,123178
+pyxecm/helper/logadapter.py,sha256=ExrIKpA2JKegkTIky0wDDTgPYSvVmwQLrDh5jko_6hQ,724
+pyxecm/helper/web.py,sha256=k010t9gzBflPxnxUdIGvulL69ASzdCEDY-UQ3JXQZ1w,13380
+pyxecm/helper/xml.py,sha256=RtWu3MdbJmmvvjMLha7tJ-nV8BrqioR51yWXxFPzCR0,43777
+pyxecm/maintenance_page/__init__.py,sha256=09to4a8rygOIN6Z1SCN9tLtW1qPUC78Z-scDbpt0E-Q,136
+pyxecm/maintenance_page/__main__.py,sha256=lFBgG3PkXz8ddYK_3wb376IoUAvpDEACVbrmx7xrFc8,158
+pyxecm/maintenance_page/app.py,sha256=aJUiZc2kNmtrl0sfg10rXBySgNBBSBCfyC6_G2Q17EU,1698
+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-2.0.0.dist-info/licenses/LICENSE,sha256=z5DWWd5cHmQYJnq4BDt1bmVQjuXY1Qsp6y0v5ETCw-s,11360
+pyxecm-2.0.0.dist-info/METADATA,sha256=IFwdFWvfSAF6N-1A_nqVa6K4PYlWCiXCGLYr_cC2_b8,5135
+pyxecm-2.0.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pyxecm-2.0.0.dist-info/top_level.txt,sha256=TGak3_dYN67ugKFbmRxRG1leDyOt0T7dypjdX4Ij1WE,7
+pyxecm-2.0.0.dist-info/RECORD,,

{pyxecm-1.5.dist-info → pyxecm-2.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyxecm-1.5.dist-info/METADATA

@@ -1,51 +0,0 @@
-Metadata-Version: 2.1
-Name: pyxecm
-Version: 1.5
-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
-Provides-Extra: customizer
-Requires-Dist: python-hcl2 ; extra == 'customizer'
-Requires-Dist: lxml ; extra == 'customizer'
-Requires-Dist: pyrfc ; extra == 'customizer'
-
-# PYXECM
-
-A python library to interact with Opentext Extended ECM REST API. 
-API documentation is available on [OpenText Developer](https://developer.opentext.com/ce/products/extendedecm)
-
-
-# Disclaimer
-
-Copyright © 2023 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-1.5.dist-info/RECORD

@@ -1,30 +0,0 @@
-pyxecm/__init__.py,sha256=f0oWCTOUQrX9JuJZaP4r-5d493lSwvrGksu8xPxg4bI,253
-pyxecm/coreshare.py,sha256=P23gGqnHFFP4akeC5ISSZXNwcNbDTFssXpIIDQdWvfI,95691
-pyxecm/otac.py,sha256=i1-4nljJUedAsz842s4WXH_YjmEC-hZh66zEGhRS5Uw,21684
-pyxecm/otcs.py,sha256=ZJvYOWiRnD_GutI6hM2923gap-xhWWtSG9jVuebE5YI,418633
-pyxecm/otds.py,sha256=Q9ZHs1vQiPz2ZbkubjKUxX2r_Gl5F0NcqrWNXxllk1E,160812
-pyxecm/otiv.py,sha256=nHEBQ9tddtKMiR1yPbGGP-jJiDaQpyoFmZcQFPgw22w,1720
-pyxecm/otmm.py,sha256=pNy5oIk70duAlOEG3e43JxpQMQbCldRL9iD0KBGyUjU,28566
-pyxecm/otpd.py,sha256=zRus7UnYYrwG9tYDPPLxBbGzozATwS07ftYun4kaaV4,12503
-pyxecm/customizer/__init__.py,sha256=g32OUKoJiBYY4q9IMQctKTKq6YhFtv-IAIHcRC0KJu4,330
-pyxecm/customizer/browser_automation.py,sha256=cbUTGBLmyYO7617QfNJCZtFCK0i8-2hfA6QhKSfuKOY,16430
-pyxecm/customizer/customizer.py,sha256=7GHsuq2njG29xL5bLqdYe5eDcw2TpBgZMJOs6X4xKrY,86293
-pyxecm/customizer/k8s.py,sha256=XMoLVQXxJwq51aXaYANwaqniYi7lqNnmVOmEkaqSuQY,36455
-pyxecm/customizer/m365.py,sha256=emZOJX503-i3FWOqVXe26geiz_apFZiI-jWtoWJxE40,184000
-pyxecm/customizer/payload.py,sha256=74n_KpNZ3s6ftDkjMP3fmsSHcrPXDb5gZrPgkcQ4Tiw,765958
-pyxecm/customizer/pht.py,sha256=AxP8v8SbzkBZaxYDJ3Dqr330l29RJwzpkuKNIW46VjM,17348
-pyxecm/customizer/salesforce.py,sha256=j2oqI4uzQdsl52hMMK9OyzL6Z3EUZYnvqEGQ_OscMEY,63787
-pyxecm/customizer/sap.py,sha256=RNrHH0KjBQ10dHXoMaZIEd3EVPC8--4AN7nzy_Iv9k4,5947
-pyxecm/customizer/servicenow.py,sha256=3ytAjLVKbWDL9MmTPPgPe7-bMDN1JLBQSGtkcGil20k,46745
-pyxecm/customizer/successfactors.py,sha256=6hww4tKF_Bm2aLzFMStPuJmKJ4uBqteXwjWDkW0yDHU,38847
-pyxecm/customizer/translate.py,sha256=RxC7O4lxfGaG1nttCm5WI5X2wEM4eEqbVcUtnYns1TQ,3968
-pyxecm/helper/__init__.py,sha256=sScoB5RQAEkzP2LLvR_cRYwC1ARSdvBiv-4JwnJA7Dw,140
-pyxecm/helper/assoc.py,sha256=MKjDgPYnRcuHkDMIvFMtYXiyMWPXpNie6UQrVgV0s-0,6488
-pyxecm/helper/data.py,sha256=__B9FVwXBPpByaRaJ-l348po3dcaBXw4J1jVzQRy608,60308
-pyxecm/helper/web.py,sha256=CYhJW4TgyHc2w9nV75YgGJR3fDHeUjQEMkulNI9U3E8,9263
-pyxecm/helper/xml.py,sha256=SjMzZcFF37p50ESewF83bh5vl1oDOIjbYRLRZNVEeOU,31664
-pyxecm-1.5.dist-info/LICENSE,sha256=z5DWWd5cHmQYJnq4BDt1bmVQjuXY1Qsp6y0v5ETCw-s,11360
-pyxecm-1.5.dist-info/METADATA,sha256=NumUPC4fUYuiZJyN39qnYX1BqOBjUPXxYFPaP3w8N08,2076
-pyxecm-1.5.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-pyxecm-1.5.dist-info/top_level.txt,sha256=TGak3_dYN67ugKFbmRxRG1leDyOt0T7dypjdX4Ij1WE,7
-pyxecm-1.5.dist-info/RECORD,,