---
id: data-platform-helpers
version: "1.1.0"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# data-platform-helpers

License: permissive · Maintenance: active · Downloads: 103.5K/mo

## What it is and what it does

data-platform-helpers is a utility library for validating version consistency across distributed data platform components, particularly in Juju charm deployments. Its primary feature is a CrossAppVersionChecker that enforces version alignment between related applications—for example, ensuring that Kafka brokers and Kafka Connect instances, or shards and cluster managers, run compatible versions. You instantiate the checker with your charm instance, the current version, and a list of relations to monitor; it then validates that related applications meet your version constraints and can report which relations have mismatched versions.

The package also includes Data Interfaces V1, a set of abstractions intended for charm libraries and other code that needs parts of the data interfaces specification but cannot use the charm-lib directly. It depends on ops (Juju charm framework), pydantic (for data validation), and rich (for terminal output). The library targets Python 3.10 and later and is classified as production-stable.

Use it for:

- Enforce version compatibility in a sharded cluster where all shards and the cluster manager must run the same component versions.
- Validate that Kafka Connect and Kafka broker applications maintain compatible underlying versions during deployments.
- Check version alignment across multiple related charm applications during upgrade or join events.
- Provide standardized data interfaces for charm libraries that need cross-application communication patterns.
- Log or fail charm events when related applications have mismatched versions that would cause operational issues.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides version checking and validation utilities for distributed data platform components, plus data interface abstractions for charm libraries.

Yes, if you are building or maintaining Juju charms for distributed data platforms and need reliable version validation across related applications. The low install friction, active maintenance, permissive license, and zero known vulnerabilities make it a safe choice. Not relevant for non-charm contexts.

## Install

pip install data-platform-helpers
uv add data-platform-helpers
poetry add data-platform-helpers

## Installing data-platform-helpers

Before you install: Low install friction with a pure Python wheel. Actively maintained with a recent release. Depends on ops, pydantic, and rich—all stable, widely-used libraries.

License in practice: Apache-2.0 permissive license allows commercial and private use with minimal restrictions.

Quickstart:

pip install data-platform-helpers==1.1.0

from data_platform_helpers.version_check import CrossAppVersionChecker
version_checker = CrossAppVersionChecker(
    charm_instance,
    version="1.0",
    relations_to_check=["relation1", "relation2"]
)
if not version_checker.are_related_apps_valid():
    print(version_checker.get_invalid_versions())

Requires Python 3.10 or later; designed for use within Juju charm applications.

Verify before relying:

- Whether the Advanced Statuses Handler and Interfaces modules are fully implemented or still in development (description marks Interfaces as V1 and Statuses as TBD).
- Specific version range syntax supported by the version_validity_range parameter.
- Whether the package works outside Juju charm contexts or is charm-specific.

## Package facts

- License: Apache-2.0 (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 103.5K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

cross-app version validation, distributed system version checking, charm library data interfaces, platform component compatibility, version mismatch detection, data platform utilities, charm relation helpers, juju-charm, version-validation, distributed-systems

[View on SkillFed](https://skillfed.io/packages/data-platform-helpers) · [View on PyPI](https://pypi.org/project/data-platform-helpers/)