Installation

Install tidysdmx and verify your environment.

tidysdmx requires Python 3.11.9 or later.

With pip

pip install tidysdmx

With Poetry

poetry add tidysdmx

From source (development)

git clone https://github.com/WB-DECIS/tidysdmx.git
cd tidysdmx
poetry install
poetry run pytest -m "not integration"

Runtime dependencies

tidysdmx depends on:

  • pysdmx — the underlying SDMX information-model library.
  • pandas — the tabular workhorse.
  • typeguard — runtime type checking.
  • openpyxl — Excel mapping template support.

Verify the install

import tidysdmx
print(tidysdmx.__version__)

from tidysdmx import (
    create_schema_from_table,
    parse_mapping_template_wb,
    build_structure_map_from_template_wb,
    map_structures,
    standardize_output,
    validate_dataset_local,
)

If the imports succeed, you’re ready to go. Continue to the quick start.

Optional: connect to FMR

Most real-world workflows fetch a dissemination schema from a Fusion Metadata Registry. The pysdmx FMR client is bundled with tidysdmx and can be instantiated directly:

import pysdmx as px
client = px.api.fmr.RegistryClient("https://fmrqa.worldbank.org/FMR/sdmx/v2")