HALFormsClient Library
Overview
The HALFormsClient library provides a Python client for interacting with RESTful services that use the HAL (Hypertext Application Language) and HAL-Forms standards. This library simplifies the handling of HAL responses and their embedded resources, enabling easy navigation and interaction with APIs that follow the HAL and HAL-Forms specifications.
Features
- Automatic token management for service accounts.
- Robust retry mechanisms for HTTP requests.
- Easy navigation of HAL links and embedded resources.
- Support for CURIEs (Compact URIs) for compacting and expanding link relations.
- Handling of common HTTP methods (
GET,POST,PATCH,DELETE,PUT) with ease. - Validation and transformation of HAL links and URIs.
- Customizable client configuration, including endpoint and authentication details.
Installation
To install the library, use pip:
pip install contentgrid-hal-client
Usage
Initialization
To initialize the HALFormsClient, you need to provide the endpoint of the HAL service and optionally authentication details:
from halformsclient import HALFormsClient
# Initialize using service account
client = HALFormsClient(
client_endpoint="https://api.example.com",
auth_uri="https://auth.example.com",
client_id="your_client_id",
client_secret="your_client_secret",
)
# Initialize using bearer token
client = HALFormsClient(
client_endpoint="https://api.example.com",
auth_uri="https://auth.example.com",
token="your_token"
)
# Initialize using session cookie
client = HALFormsClient(
client_endpoint="https://api.example.com",
auth_uri="https://auth.example.com",
session_cookie="your_session_cookie"
)
Fetching and Interacting with HAL Resources
You can fetch a HAL resource and interact with it using the provided methods:
# Fetch a resource by following a link
resource = client.follow_link(HALLink(uri="/some/resource"))
# Access metadata
print(resource.metadata)
# Access links
links = resource.get_links("key")
# Access embedded resources
embedded_objects = resource.get_embedded_objects_by_key("embedded_key")
# Update a resource with PUT or PATCH
resource.put_data({"key": "value"})
resource.patch_data({"key": "new_value"})
# Delete a resource
resource.delete()
Handling CURIEs
CURIEs (Compact URIs) are supported for compacting and expanding link relations:
curie_registry = CurieRegistry(curies=[{"name": "ex", "href": "https://example.com/{rel}"}])
expanded_uri = curie_registry.expand_curie("ex:some_relation")
compact_uri = curie_registry.compact_curie("https://example.com/some_relation")
Error Handling
The library provides custom exceptions for common HTTP errors:
from halformsclient.exceptions import BadRequest, Unauthorized
try:
resource = client.follow_link(HALLink(uri="/some/invalid/resource"))
except BadRequest as e:
print(f"Bad request: {str(e)}")
except Unauthorized as e:
print(f"Unauthorized: {str(e)}")
1 maintainer
Metadata
1 maintainer
Release files for contentgrid-hal-client 0.2.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| contentgrid_hal_client-0.2.11.tar.gz | 26.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| contentgrid_hal_client-0.2.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 44.5 kB
Release files / contentgrid_hal_client-0.2.11.tar.gz
| Download URL | contentgrid_hal_client-0.2.11.tar.gz |
|---|---|
| Size | 26.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
36cec5656bfefd013a3499c95a21e272cbfa3c52dc2954f0bfd19deaed5d599e
|
|
BLAKE2b-256 checksum How to use checksums |
a41ee44fef1d1f8fdce5a52b66bd90dfc4232ead150539e455914303bec46384
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.
Transparency logRelease files / contentgrid_hal_client-0.2.11-py3-none-any.whl
| Download URL | contentgrid_hal_client-0.2.11-py3-none-any.whl |
|---|---|
| Size | 18.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
636c6d89a0c0922ed643b1a905e93a2684aca8e2c71ad31bbf2e2ac84660acaa
|
|
BLAKE2b-256 checksum How to use checksums |
44b986f1c7f7e77abee3916d36e6c9c4b3507e83c9a299ae1a03a81c052dea31
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.
Transparency log
