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

pyxecm-3.0.1.dist-info/METADATA

@@ -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.0.dist-info → pyxecm-3.0.1.dist-info}/RECORD

@@ -90,7 +90,7 @@ pyxecm_maintenance_page/app.py,sha256=pTOeZfgPPq6BT7P8naUjW-ZT9dXqwX6DWazIVL-9Fk
 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.0.0.dist-info/METADATA,sha256=3uq-NrrqgoEj56ACyRlWMOpvC8LDfYWAGYwD8jlQ3y0,2239
-pyxecm-3.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pyxecm-3.0.0.dist-info/entry_points.txt,sha256=prc1mDdpd3bQk98VRBozI363mDUgSwDibDKXGNqKqgI,151
-pyxecm-3.0.0.dist-info/RECORD,,
+pyxecm-3.0.1.dist-info/METADATA,sha256=DpJqpnLy9py7ju-mO8HRQ4Rddm5EuHWADJ50cU71bRQ,4512
+pyxecm-3.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyxecm-3.0.1.dist-info/entry_points.txt,sha256=prc1mDdpd3bQk98VRBozI363mDUgSwDibDKXGNqKqgI,151
+pyxecm-3.0.1.dist-info/RECORD,,

pyxecm-3.0.0.dist-info/METADATA

@@ -1,48 +0,0 @@
-Metadata-Version: 2.4
-Name: pyxecm
-Version: 3.0.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>
-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'