ContentGrid Application Client
This ContentGrid Client is a Python library designed to interact with ContentGrid API endpoints, specifically in the HAL response type. For ContentGrid Applications, it provides a convenient interface for performing various operations such as fetching profiles, creating entities, fetching related entities, handling content attributes, and more.
Features
- Profile Handling: Fetch profiles to retrieve HAL-forms specification about available entities and their attributes.
- Entity Operations: Create, fetch, update, and delete entities using a simple functions without needing to worry about headers and authentication.
- Content Handling: Upload and download content on content-attributes of entities.
- Error Handling: Provides basic error handling for network requests.
- Attribute validation: Provides attribute type checks for creating and updating entities. Checks wether attributes have the correct type and if all required attributes are present.
Installation
To install the ContentGrid API Client, you can use pip:
pip install contentgrid-application-client
Usage
ContentGridApplicationClient
from contentgrid-application-client import ContentGridApplicationClient
# Initialize the client with service account
client = ContentGridApplicationClient(
client_endpoint="https://b93ccecf-3466-44c0-995e-2620a8c66ac3.eu-west-1.contentgrid.cloud",
auth_uri="https://auth.eu-west-1.contentgrid.cloud/realms/cg-eade54da-3903-4554-aa5e-2982cd4126f1/protocol/openid-connect/token",
client_id="your_client_id",
client_secret="your_client_secret"
)
# Initialize the client with token
client = ContentGridApplicationClient(
client_endpoint="https://b93ccecf-3466-44c0-995e-2620a8c66ac3.eu-west-1.contentgrid.cloud",
token="your_token"
)
# Fetch profile
profile = client.get_profile()
# Create entity
attributes = {
"name": "Example Entity",
"description": "This is an example entity"
}
entity = client.create_entity("entity-name", attributes)
Testing
Installing requirements:
pip install -r requirements.txt
Running tests:
python -m pytest
Running tests with coverage:
coverage run -m pytest && coverage report -m
1 maintainer
Metadata
1 maintainer
Release files for contentgrid-application-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_application_client-0.2.11.tar.gz | 82.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| contentgrid_application_client-0.2.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 97.7 kB
Release files / contentgrid_application_client-0.2.11.tar.gz
| Download URL | contentgrid_application_client-0.2.11.tar.gz |
|---|---|
| Size | 82.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b3a59a9ef968d2f020cf214e5ee0a5f505735bd21d22d4a957530466846cce4
|
|
BLAKE2b-256 checksum How to use checksums |
a3ffaea5b67dca2a938c96e3ad5a54def3e28c93d0cec2f79e0d4507e490dc12
|
| 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_application_client-0.2.11-py3-none-any.whl
| Download URL | contentgrid_application_client-0.2.11-py3-none-any.whl |
|---|---|
| Size | 15.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7c06d26697e4bd8f27dc8ff4aa4499a25d3e8a3386cbfaeebadf18ded5737341
|
|
BLAKE2b-256 checksum How to use checksums |
2974da89d124a32c98fd72489141c93801773ac9efa904773b6cdbc2f8fa6d06
|
| 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
