PineXQ 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 pinexq.client.job_management.enterjma import enter_jma
from pinexq.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
Job-Management Interface
There is a convenience layer wrapping job-management-specific objects in interface classes for ease of use.
from pinexq.client.job_management.tool import Job
from pinexq.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_completion()
)
result = job.get_result()
Raw Hypermedia API
In the spirit of a hypermedia API you can also use low level calls to navigate the API, e.g. when features are not yet exposed in the convenience wrapper.
from pinexq.client.job_management.enterjma import enter_jma
from pinexq.client.job_management.hcos.entrypoint_hco import EntryPointHco
from pinexq.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", ]))
...
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pinexq_client-1.11.0-py3-none-any.whl.
File metadata
- Download URL: pinexq_client-1.11.0-py3-none-any.whl
- Upload date:
- Size: 104.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9cbc8fbaff1c68dcdd8f28e7e4016cf9c4c396362175ab4d47ac49922d57518c
|
|
| MD5 |
1096e1ab1a3997ec3d42e47114027390
|
|
| BLAKE2b-256 |
3be0435e3bc5bb141f765d7c30951c81b367cfea1bb59bcf1d8402216cdb6ee8
|
