pyetp 0.0.51

Interface with OSDU RDDMS using ETP protocol

Pyetp is a library implementing an ETP v1.2 client with utilities and support for working with RESQML v2.0.1 models.

The following Energistics (c) products were used in the creation of this work: Energistics Transfer Protocol (ETP) v1.2 and RESQML v2.0.1

Installing the library

This package is published to PyPI, and can be installed via:

pip install pyetp

The library is tested against Python versions 3.11, 3.12 and 3.13.

Local development

Locally we suggest setting up a virtual environment, and installing the latest version of pip. Then install the library in editable mode along with the dev-dependency group. That is:

python -m venv .venv
source .venv/bin/activate
pip install pip --upgrade
pip install -e .
pip install --group dev

After doing changes to the code, make sure to lint, format, check the types, and run tests and see that they pass.

Linting and formatting

We use ruff as a linter and formatter. To lint run:

ruff check

To run the formatter do:

ruff format

Or if you just want to check what could have been formatted:

ruff format --check

Type checking

We use mypy to check type annotations via:

mypy src tests --strict

Running tests

We have set up tests against a local open-etp-server. To start this server run:

docker compose -f tests/compose.yml up [--detach]

If you want to re-use the same terminal window you should use the --detach-option, otherwise start a new terminal. We use pytest for testing, which can be run via:

py.test

Building the documentation

We use Material for Mkdocs for the documentation. To install the documentation dependencies run

pip install --group docs

While developing the documentation run

mkdocs serve --livereload

for hot-reloading. The pages are served at http://localhost:8000. To build the documentation for publication run

mkdocs build

which create a directory site/ with the pages. Open site/index.html to see the result.

RESQML versions

The library is built and tested against RESQML v2.0.1. The spec can be downloaded here.

Generated Python objects from RESQML spec

Under src/pyetp/resqml_objects/v201/generated.py you will find Python objects generated from the RESQML xml spec.