pinexq-client 0.2.0.2024.607.8

A hypermedia-based client for the DataCybernetics PinexQ platform.

Pine-x-Q Python Client

A hypermedia-based client for the DataCybernetics PinexQ platform.

This module contains the submodules:

• core: A generic hypermedia client (HC) to work with siren hypermedia APIs Siren on GitHub

• job_management: Specialized HC-object (HCO) implementations for the PinexQ Job-Management API (JMA).

Installation

Install from PyPI by running

pip install pinexq-client

Setup the Client

The hypermedia client uses HTTPX as a backend. To access the API you need to provide a pre-configured HTTPX-client with a valid API key for authentication. From The API key the user and permissions are derived so do not share the API key and store it securely.

To initialize the client parts must be supplied:

• The API key (as header)
• The API host as URL with port if required

from httpx import Client

from hypermedia_client.job_management.enterjma import enter_jma
from hypermedia_client.job_management.hcos.entrypoint_hco import EntryPointHco


client = Client(
    base_url="https://myapihost.com:80", 
    headers={'x-api-key': '<SECRET_PAT>'}
)

# the client is now ready to be passed to function entering the API
entrypoint: EntryPointHco = enter_jma(client)

Using the API

There is a convenience layer wrapping job-management-specific objects in interface classes for ease of use. In the spirit of a hypermedia API you can also use low level calls to navigate the API.

Job-Management Interface

The main concepts of the job-management-API (e.g. "Jobs") are wrapped in

from hypermedia_client.job_management.tool import Job
from hypermedia_client.job_management.model import JobStates
job = (
    Job(client)
    .create(name="JobName")
    .select_processing(processing_step="step_function_name")
    .configure_parameters(param_name="value")
    .start()
    .wait_for_state(JobStates.completed)
)
result = job.get_result()

Raw Hypermedia API

You can navigate and use the full API with raw hypermedia primitives, e.g. when features are not yet exposed in the convenience wrapper.

from hypermedia_client.job_management.enterjma import enter_jma
from hypermedia_client.job_management.hcos.entrypoint_hco import EntryPointHco
from hypermedia_client.job_management.model import CreateJobParameters, SetJobTagsParameters

entrypoint: EntryPointHco = enter_jma(client)
# Get to jobs root
job_root = entrypoint.job_root_link.navigate()
# Create a new job
parameters = CreateJobParameters(name="Test Job")
job = job_root.create_job_action.execute(parameters).navigate()
# Edit the job's tags
job.edit_tags_action.execute(SetJobTagsParameters(tags=["test", ]))

...