ContentGrid Management Client
This ContentGrid Management Client is a Python library designed to interact with the ContentGrid Management API endpoints, specifically in the HAL response type. It provides a convenient interface for performing various operations such as fetching organizations, projects, and blueprints, and managing automations and automation annotations.
Features
- Organization Handling: Fetch organizations and their associated projects.
- Project Handling: Fetch projects and their associated blueprints.
- Blueprint Handling: Manage blueprints including entity definitions and automations.
- Automation Management: Create and manage automations and their annotations.
- Error Handling: Provides basic error handling for network requests.
Installation
To install the ContentGrid Management Client, you can use pip:
pip install contentgrid-management-client
Usage
Initialization and Organization Handling
from contentgrid_client import HALFormsClient
# Initialize a HALFormsClient with service account
client = HALFormsClient(
client_endpoint="https://api.contentgrid.com/",
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 a HALFormsClient with a token
client = HALFormsClient(
client_endpoint="https://api.contentgrid.com/",
auth_uri="https://auth.eu-west-1.contentgrid.cloud/realms/cg-eade54da-3903-4554-aa5e-2982cd4126f1/protocol/openid-connect/token",
token="your_token"
)
# Get all organizations
organization = get_organizations(hal_client=client)[0]
Project Handling
# Get the first project
project = organization.get_projects()[0]
# Get blueprints of the project
blueprints = project.get_blueprints()
Blueprint Handling
# Get a specific blueprint
blueprint = project.get_blueprint_by_name("blueprint_name")
# Create a new entity definition in the blueprint
entity_definition = blueprint.create_entity("entity_name", "entity_description")
# Get entity definitions
entity_definitions = blueprint.get_entity_definitions()
Automation Management
# Get automations in a blueprint
automations = blueprint.get_automations()
# Create a new automation in the blueprint
automation_data = {
"foo" : "bar"
}
automation = blueprint.create_automation("automation_name", "system_name", automation_data)
# Create an annotation for an automation
annotation_data = {
"key": "value"
}
annotation = automation.create_annotation_on_entity("entity_name", annotation_data)
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-management-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_management_client-0.2.11.tar.gz | 36.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| contentgrid_management_client-0.2.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.1 kB
Release files / contentgrid_management_client-0.2.11.tar.gz
| Download URL | contentgrid_management_client-0.2.11.tar.gz |
|---|---|
| Size | 36.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9461dff625f575d21043662d5bbfa684f53b1b0174a6e1b75e7aced467bd720b
|
|
BLAKE2b-256 checksum How to use checksums |
9d9b2980085367c7acfe498418cbe465b25faa4927f4a710e3561ec937e8b76c
|
| 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_management_client-0.2.11-py3-none-any.whl
| Download URL | contentgrid_management_client-0.2.11-py3-none-any.whl |
|---|---|
| Size | 9.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eafb41d8c721e4185c7fc14b27f8f732db65b9ab936c48cb801154e43ee5bb7e
|
|
BLAKE2b-256 checksum How to use checksums |
edfd465eea2749911664a0c49835978e9fe104e0158e821e200de4e75129a6a1
|
| 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
