Skip to main content

Python API clients for the HIRMEOS project.

Project description


Python clients for interacting with APIs that were developed as part of the HIRMEOS project.

Once this has been shown to be working properly, and able to integrate with the HIRMEOS drivers it can be moved to a HIRMEOS/OPERAS PyPI Repo.

Until CI is ready

.. code-block:: bash

$ python3 sdist bdist_wheel
$ twine upload dist/*

Note: We are still in the early stages of this project so there will be many breaking changes as we go along.

Release Notes:

[0.1.6] - 2022-11-04


  • Update tests (minor)


  • Update PyJWT requirement, as lower versions had security vulnerabilities.

[0.1.5] - 2022-05-20


  • Add tag uri schemes to variables list.

[0.1.4] - 2021-12-02


  • Update processing canonical identifiers in the translator client logic to allow multiple works to be returned when uri_strict=True is used.

[0.1.3] - 2021-10-20


  • Update requirements to be more flexible

[0.1.2] - 2021-10-15


  • Allow canonical URIs to be set when creating works in the translator service
  • Main identifier will be registered as a canonical identifier when creating a work

[0.1.1] - 2021-10-15


  • Add method to delete URIs from a work
  • Add method to update/set the canonical flag for a URI

[0.1.0] - 2021-02-02


  • Unit Tests for Translator Client
  • Translator Client attributes: remove_uri_trailing_slash & use_lower_case_uris. These automatically format URIs for consistency.

[0.0.20] - 2021-01-26


  • TokenClient Bug Fix: Check encoded token type before attempting to decode.

[0.0.19] - 2021-01-26


  • TokenClient Code Change: Separate token encode and decode steps (for debugging).

[0.0.18] - 2020-07-30


  • TokenClient Bug Fix: Correctly update request header after refreshing token.

[0.0.17] - 2020-07-29


  • TokenClient: update request header after refreshing token, and before retrying request.

[0.0.16] - 2020-07-29


  • TokenClient: When creating token, convert from bytes to a string.

[0.0.15] - 2020-07-29


  • TranslatorClient.work_exists: Report all content from the translation API response when this method fails (investigation).

[0.0.14] - 2020-07-29


  • TranslatorClient.work_exists: Report 'data' content from the translation API when this method fails (investigation).

[0.0.13] - 2020-07-27


  • Token creation option: The TokenClient can now also be used to create a token, based on the logic used by the Tokens API.

[0.0.12] - 2020-05-20


  • New client: AltmetricsClient

[0.0.11] - 2020-04-15


  • TranslatorClient.prepare_uri: Now returns the URI as a string in the format expected by TranslatorClient.get_work_uris.

[0.0.10] - 2020-04-15


  • TranslatorClient.post_new_work: 'uris' parameter now assumes the same format as the output from TranslatorClient.get_work_uris, which was causing errors. (bug fix)

[0.0.9] - 2020-04-06


  • translator: Reference variables for work types and URI schemes.
  • translator: Check if a work exists.
  • translator: Fetch all URIs associated with a work.
  • translator: Post new work.

[0.0.8] - 2020-03-06


  • Make requirements for flexible to avoid conflicts with other packages.

[0.0.7] - 2020-03-06


  • Release notes


  • Strip trailing slash from TranslatorClient API base.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distribution

hirmeos_clients-0.1.6-py3-none-any.whl (11.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page