Skip to content

Commit 29b212c

Browse files
committed
Release Version 3.0.0
1 parent 0063ef2 commit 29b212c

File tree

125 files changed

+26026
-16817
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+26026
-16817
lines changed

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,9 @@ build/
1010
.env
1111
pyxecm/.vscode/
1212
~$*
13+
14+
pyproject.toml
15+
16+
uv.lock
17+
18+
packages/pyxecm/tests/

Makefile

Lines changed: 0 additions & 19 deletions
This file was deleted.

README.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,21 @@
11
# PYXECM
22

3-
A python library to interact with Opentext Extended ECM REST API.
3+
A python library to interact with Opentext Content Mangement REST API.
44
The product API documentation is available on [OpenText Developer](https://developer.opentext.com/ce/products/extendedecm)
55
Detailed documentation of this package is available [here](https://opentext.github.io/pyxecm/).
66

7-
# Quick start
7+
## Quick start - Library usage
88

9-
Install pyxecm with the desired extras into your python environment, extra options are:
10-
11-
- browserautomation
12-
- dataloader
13-
- sap
9+
Install the latest version from pypi:
1410

1511
```bash
1612
pip install pyxecm
1713
```
1814

19-
## Start using the Customizer
20-
21-
Create an `.env` file as described here: [sample-environment-variables](customizerapisettings/#sample-environment-variables)
22-
23-
```bash
24-
python -m pyxecm.customizer.api
25-
```
15+
### Start using the package libraries
2616

17+
example usage of the OTCS class, more details can be found in the docs:
2718

28-
Access the Customizer API at [http://localhost:8000/api](http://localhost:8000/api)
29-
30-
31-
## Start using the package libraries
3219
```python
3320
from pyxecm import OTCS
3421

@@ -50,8 +37,30 @@ for node in nodes["results"]:
5037
print(node["data"]["properties"]["id"], node["data"]["properties"]["name"])
5138
```
5239

40+
## Quick start - Customizer usage
41+
42+
- Create an `.env` file as described here: [sample-environment-variables](customizerapisettings/#sample-environment-variables)
43+
- Create an payload file to define what the customizer should do, as described here [payload-syntax](payload-syntax)
44+
45+
```bash
46+
pip install pyxecm[customizer]
47+
48+
pyxecm-customizer PAYLOAD.tfvars/PAYLOAD.yaml
49+
```
50+
51+
## Quick start - API
52+
53+
- Install pyxecm with api and customizer dependencies
54+
- Launch the Rest API server
55+
- Access the Customizer API at [http://localhost:8000/api](http://localhost:8000/api)
56+
57+
```bash
58+
pip install pyxecm[api,customizer]
59+
60+
pyxecm-api
61+
```
5362

54-
# Disclaimer
63+
## Disclaimer
5564

5665
!!! quote ""
5766
Copyright © 2025 Open Text Corporation, All Rights Reserved.

customizerapisettings.env

Lines changed: 0 additions & 60 deletions
This file was deleted.

customizerapisettings_doc.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

0 commit comments

Comments
 (0)