Skip to main content

Library for interacting with the OECD Data Explorer through Python

Project description

notoecd

⚠️ Unofficial package, not endorsed by the OECD.

A lightweight Python interface for exploring OECD SDMX structures and downloading OECD datasets.
The package provides utilities for:

  • Discovering dataset metadata
  • Searching for relevant datasets using keyword matching
  • Exploring the structure and code lists of a dataset
  • Fetching filtered SDMX data directly into a pandas DataFrame

Installation

You can install the package by running:

pip install notoecd

Quick Start

import notoecd

The main functions in this module are:

search_keywords(keywords) -> pd.DataFrame
get_structure(agencyID, dataflowID) -> Structure
get_df(agencyID, dataflowID, filters) -> pd.DataFrame

Searching for datasets

search_keywords performs:

  • Normalized text matching
  • Accent-insensitive search
  • Multi-keyword OR matching
  • Ranking by number of matched keywords

Example:

hits = notoecd.search_keywords(['gross domestic product', 'tl2', 'tl3'])

This returns datasets that mention GDP and regional levels (TL2/TL3). It gives their name, description, and identifiers (agencyID and dataflowID), which we will need for the next step.


Inspecting dataset structure

Once a dataset is identified, load its SDMX structure:

dataset = 'Gross domestic product - Regions'
agencyID = 'OECD.CFE.EDS'
dataflowID = 'DSD_REG_ECO@DF_GDP'

s = notoecd.get_structure(agencyID, dataflowID)

Table of contents

s.toc

This shows all filters and their available values.

Exploring code values

s.explain_vals('MEASURE')
s.explain_vals('UNIT_MEASURE')

This shows the available measures and units used in the dataset.


Filtering and downloading data

To download data, build a dictionary of filters.
Keys correspond to SDMX dimensions, values are strings or lists (for multiple values):

filters = {
    'territorial_level': ['tl2', 'tl3'],
    'measure': 'gdp',
    'prices': 'Q',
    'unit_measure': 'USD_PPP_PS'
}

Fetch the filtered dataset:

df = notoecd.get_df(agency, dataflow, filters)
df.head()

The returned object is a pandas DataFrame containing the requested subset of OECD SDMX data.


Examples

You can see this full example as a notebook called example.ipynb.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notoecd-0.1.1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

notoecd-0.1.1-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file notoecd-0.1.1.tar.gz.

File metadata

  • Download URL: notoecd-0.1.1.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for notoecd-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8be071d32f97594abb09618fdf866986480ece80e73f03cb1cc5b1f0799b18e2
MD5 3cdc4a8e14649990911ca5a5c84d462f
BLAKE2b-256 d5192375e280647fce4819bc3afa1520e9749836d8efb8890e45232b28f324a4

See more details on using hashes here.

File details

Details for the file notoecd-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: notoecd-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for notoecd-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2729cfe706162686bc7a44ab8b81b7341160d472c1ada403b4323522eca0ac55
MD5 885f8f38168ef1f5b08c56a9ca5a07c2
BLAKE2b-256 098169c500e34b5cd620049179b3358c9a746601f2a8fb36b913aec0e9942e62

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page