Cua Core Library

0.1.19 · active · verified Sun Apr 12

cua-core is a Python library providing core utilities and telemetry functionality for the Cua ecosystem. It includes shared components for configuration, logging, versioning, and OpenTelemetry integration. Currently at version 0.1.19, it is designed primarily as a dependency for other Cua-related libraries and is explicitly not intended for direct end-user applications. Its release cadence is likely tied to the development cycles of other Cua projects.

Warnings

breaking As a `0.x.x` version library, `cua-core` may introduce breaking changes without prior deprecation warnings between minor or patch releases. Its API is not considered stable for external use.
Fix: If directly depending on `cua-core`, pin exact versions for stability (e.g., `cua-core==0.1.19`). Prefer relying on higher-level Cua libraries for stable interfaces, as they manage `cua-core` internally.
gotcha `cua-core` is intended as an internal dependency for the Cua ecosystem and is explicitly "not intended for direct use" by end-user applications. Its public API may not be fully documented or user-friendly, and its design prioritizes internal consistency over external usability.
Fix: Prefer using higher-level Cua libraries that encapsulate `cua-core`'s functionality and provide a stable, user-facing API. Only use `cua-core` directly if building another library within the Cua ecosystem or if fully understanding its internal mechanics.
gotcha Many core functionalities, especially telemetry and logging, are tightly integrated with Google Cloud Platform (GCP) services (e.g., Google Cloud Logging, Monitoring, OpenTelemetry Exporter for GCP). Direct use of these features requires a properly configured GCP environment.
Fix: Ensure your environment has appropriate GCP credentials (e.g., `GOOGLE_APPLICATION_CREDENTIALS` environment variable pointing to a service account key file) and necessary IAM permissions for Google Cloud Logging and Monitoring.

Install

pip install cua-core Install latest version

Imports

get_library_version
```
from cua_core.utils import get_library_version
```
A common utility function to retrieve the library's version.
TelemetryClient
```
from cua_core.telemetry import TelemetryClient
```
The main class for managing OpenTelemetry client interactions, typically initialized by higher-level Cua libraries.

Quickstart

Demonstrates a basic interaction with `cua-core` by retrieving its version, highlighting its utility-centric nature. It also provides a commented example for `TelemetryClient` with a reminder about its dependency role and GCP requirements.

from cua_core.utils import get_library_version

# Retrieve the version of the cua-core library itself.
# This function provides a simple, direct interaction with the library's utilities.
library_version = get_library_version()
print(f"Cua Core Library Version: {library_version}")

# Further utilities exist in cua_core.utils and cua_core.telemetry,
# but their direct usage is generally discouraged as cua-core is primarily a dependency.
# For example, to instantiate a TelemetryClient:
# from cua_core.telemetry import TelemetryClient
# tele_client = TelemetryClient(project_id=os.environ.get('GCP_PROJECT_ID', 'your-gcp-project-id'), service_name="my-app")
# However, this requires a valid GCP project ID and is usually handled by higher-level Cua libraries.

view raw JSON →