cml-conversion-helpers 0.3.0

Helper functions for converting data to the NHS CML schema format.

cml-conversion-helpers

Helper functions for converting tidy-format datasets into the NHS CML schema (metric and dimension tables).

What this library does

CML expects data in two tables:

• Metric table — one row per data point, with fields such as metric_id, metric_value, location_id, reporting_period_start_datetime, etc.
• Dimensions table — one row per data point, one column per dimension (e.g. age group, ethnicity), linked to the metric table via dimension_cohort_id.

This library takes a tidy-format source dataset (where dimensions are stored as rows, not columns) and provides utilities to transform it into those two tables.

Installation

pip install cml-conversion-helpers

Modules

• cml_conversion_helpers.processing — DataFrame transformation functions

Documentation

• Getting Started — installation, concepts, and input data requirements
• Usage Guide — config-driven, scripting, or hybrid approaches with full examples
• API Reference — full function reference grouped by module

Development

Codespaces

If you're using GitHub Codespaces, the container will set itself up automatically — just wait a few minutes for it to finish. Once it's ready, activate the Poetry environment in the terminal:

eval $(poetry env activate)

Local

poetry install
poetry run pytest

Acknowledgements

Some code written by Claude (Anthropic).